Configuring Orchestration CLI

The extension for Orchestration CLI is bundled with the product. If required, you can download it as a stand-alone feature also.

Before you begin

You must have completed any one of the following tasks:

Downloaded the latest version of HCL Universal Orchestrator.

or

Downloaded the executable files of Orchestration CLI.

About this task

After you download the required files for Orchestration CLI, you need to configure the config.yaml extension file by any source code editor. The config.yaml file contains mandatory and optional fields. To create the config.yaml file, you must run the Orchestration CLI file using the command prompt.

Procedure

  1. Navigate to the directory where you have downloaded the files for Orchestration CLI.
  2. Run Orchestration CLI from the command line.
    Note: For windows, you can also use powershell to run the file.
  3. Type ocli plan as command, and then press enter to create the config.yaml file.

    In Windows operating system, the config.yaml file is created at c:\Users\user_name\.OCLI.

    In Unix operating systems, the config.yaml file is created at home/user_name/.OCLI.

  4. Open the config.yaml file by using any source code editor.
  5. Perform the following actions in the config.yaml file.

    You must enter valid details for the mandatory fields. If required, you can also specify the optional fields.

    Table 1. Mandatory fields
    Option Action
    connection
    host Enter the host name or IP address of the remote engine that you want to use.
    port Enter the port number of the remote engine that you want to use.
    jwt When the connection is established for the first time, this field is filled in automatically. For more information, see Authenticating Orchestration CLI using API Keys.
    Table 2. Optional fields
    Option Actions
    lang You can use this option to specify any one of the supported languages. The following languages are supported in Orchestration CLI:
    • Brazilian Portuguese (pt_BR)
    • English (EN, the default value)
    • French (FR)
    • German (DE)
    • Italian (IT)
    • Japanese (JA)
    • Korean (KO)
    • Simplified Chinese (zh_CN)
    • Spanish (ES)
    • Traditional Chinese (zh_TW)
    Important: You must ensure that the recent version of powershell is installed on Windows operating system to view the content in the selected language.
    dateformat The date format is specific to the commands you run on Orchestration CLI. The default format is ymd. If you do not specify any format the default one is applied.
    current_folder Specify the path to any folder that will be taken as an absolute path, when you run the commands. The default value is "/".
    default workstation You can specify a workstation as default for Orchestration CLI model item definitions. The workstation mentioned is used as the reference, if you do not specify any workstation in an item definition. The default value is TEST_AGENT.
    local_timezone You can use this option to specify the timezone. If not, the time zone of the operating system is referred. The supported formats are:
    • The extended form "area/city". For example, "America/New_York” for EST.
    • The 3 character notation, for example ECT (European Central Time).
    logging
    level You can use this option to filter the log messages that are retrieved in the ocli.log file. When you set a value, all the messages equal to that severity and above are sorted. The default value is info. To view the file, navigate to C:\Users\user_name\.OCLI\logs. You can enter any one of the following message types. The message types are listed from lower to higher severity.
    • info:

      Any additional information which are not tied to the current task or action.

    • trace:

      Messages that provides information about the application flow.

    • debug:

      Informational messages that are useful to troubleshoot the application.

    • warning:

      Messages related to user actions that will have an unexpected or unwanted consequences.

    • error:

      Messages related to errors or critical failures that may block the users to proceed further until the issue is resolved.

    • fatal:

      Messages related to errors that will cause the Orchestration CLI to close without saving any data.

    • panic:

      Messages related to errors that will cause the Orchestration CLI to close without saving any data. The error is similar to a fatal error and the only difference is the way the application is closed.
    redirect_to

    You can use this option to change the location of the log file. The default location is c:\Users\user_name\.OCLI\logs.

    You can use this option to change the location of the log file. The default location is /home/user_name/.OCLI/logs.
    file_size You can specify the maximum size of the log file in Mega Bytes(MB). The default value is 10.
    backup_files You can specify the number of log files which you want to save. The default value is 3.
    connection
    contextroot You can specify the endpoint that connects with the server. The default value is /,/twsd/cli.
    protocol Enter the protocol that you want to use to connect to the remote engine. The default value is https.
    insecure Enter true, to ignore the host name error on SSL certificate. The default value is false.
    proxy Specify the proxy IP address, if you are using a proxy server.
    proxyport Specify the port of the proxy server.
    proxyuser Provide the user name of the proxy account, if authentication is required.
    proxypassword Provide the proxy account password.
    timeout You can use this option to specify the maximum time in milliseconds to display the timeout error message. The default value is 3600.
    show_warnings If you do not want to receive any warnings when there is an internet connection failure, set the option to false. The default value is true.
    compatibility
    show_copyright_header If you do not want the copyright content to be displayed when you run a command, set the option to false. The default value is true.
  6. Save the config.yaml file.

Results

You have successfully configured Orchestration CLI.
Note: Orchestration CLI generates temporary files inside the default temporary folder of the operative system. Ensure all Orchestration CLI users have read and write permissions on that temporary folder.

What to do next

You can run the commands using Orchestration CLI to accomplish specific results. For more information, see Running commands from Orchestration CLI.