Home
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
Orchestration CLI commands
You can use the various command options in Orchestration CLI to achieve specific results. The command options are not case sensitive and you can use either uppercase or lowercase letters.
Context commands
The term context refers to the set of parameters in the config.yaml file that is used to establish an environment to run HCL Universal Orchestrator. You can create multiple contexts in the config.yaml file to manage the workload. This helps you to utilize the resources in a more efficient manner.
new
You can use the new command to create a new context in the config.yaml file.

Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
- Orchestration CLI commands
  You can use the various command options in Orchestration CLI to achieve specific results. The command options are not case sensitive and you can use either uppercase or lowercase letters.
  - Access required to run Orchestration CLI commands
    You must have specific permissions to run each command in Orchestration CLI. The level of access to run the command is customizable and you can use Dynamic Workload Console (DWC) or Orchestration CLI to manage the roles.
  - Context commands
    The term context refers to the set of parameters in the config.yaml file that is used to establish an environment to run HCL Universal Orchestrator. You can create multiple contexts in the config.yaml file to manage the workload. This helps you to utilize the resources in a more efficient manner.
    - list
      You can use the list command to display the contexts available in the config.yaml file.
    - new
      You can use the new command to create a new context in the config.yaml file.
    - remove
      You can use the remove command to remove an existing context from the config.yaml file.
    - set
      You can use the set command to update and manage the parameters or properties of each context in the config.yaml file.
    - switch
      You can use the switch command to change the default context.
  - Model commands
    You can use the model commands to create or modify the item definitions for folders, jobs, job streams, and other scheduling or security items.
  - Plan commands
    You can use the plan commands to submit and run the job or job streams.
  - Plug-in commands
    You can use the plug-in commands to install, delete, or update plug-ins supported by HCL Universal Orchestrator.
  - help
    You can use the help command to view the online help or details about the commands that Orchestration CLI supports.
  - version
    You can use the version command to view the version of Orchestration CLI that is installed in your system.
  - Managing multiple config.yaml files
    You can create multiple config.yaml files in the database to run commands on different contexts without changing the default context. The feature permits you to use multiple config.yaml files at the same time.
  - Managing multiple formats
    You can set the format by configuring the config.yaml file or by adding the parameter in model commands.
  - Modifying context parameter temporarily
    You can temporarily modify the parameters in the default config.yaml file when you run a plan, model or plug-in command. This feature permits you to customize the behavior of a specific command without modifying the entire config.yaml file.
  - Special characters as wildcards and delimiters
    When you want to use filters to select scheduling items in the database, you can use a list of selected special characters as wildcards and delimiters.
  - Orchestration CLI return codes
    Orchestration CLI return codes
- Job stream definition
  This topic introduces the job stream definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Job definition
  This topic introduces the job definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Calendar definition
  This topic introduces the calendar definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Folder definition
  This topic introduces the folder definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Credentials definition
  This topic introduces credentials definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Variable table definition
  This topic introduces the variable table definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Workstation definition
  This topic introduces the workstation definition, that can be done from the Orchestration CLI and from the Dynamic Workload Console.
- Managing an event source definition from the Orchestration CLI
  In this topic you can find the syntax to manage an event source definition.
- Event plug-in structure
- Static pools
  A static pool in HCL Universal Orchestrator groups multiple workstations together and manages the workload by assigning jobs to available workstations within the pool. This helps to optimize resource utilization.
- Managing matching criteria
  In this topic you can find a description of matching criteria.
- Managing HCL UnO agent in Unix operating systems
  You can manage the agent by using scripts that are generated while configuring the agent or by Daemon process. It is recommended to use any method for ideal cohesion and efficient administration.
- Managing HCL UnO agent in Windows operating systems
  You can manage the agent by using scripts that are generated while configuring the agent or by Daemon process. It is recommended to use any method for ideal cohesion and efficient administration.
- Managing time zones
  In this topic you can find information about managing time zones.
- Policy-driven plan
  The new HCL Universal Orchestrator policy-driven adaptive plan makes your workload more autonomous, dynamic and scalable.
- Parsing OCLI files in streaming
  HCL Universal Orchestrator enables you to add or replace files containing multiple item types through OCLI in a single command.
- Data exchange and transformation
  This topic explains how you can streamline your workflows using data exchange and transformation.

new

You can use the new command to create a new context in the config.yaml file.

Syntax and command line options

You can enter the command as follows:

ocli context new context_name

The context_name parameter is mandatory. Once you provide the context name a message is displayed to enter URL. You must provide the host and port name separated by a colon (:). These are mandatory values that you must provide to create a context. For more details see the following example.

Example:

Follow the below steps to create a context named TEST with localhost and 8080 as host and port respectively.
1. Enter the command
```
ocli context new TEST
```
  The following message is displayed to add host and port name
```
ocli context new TEST
Enter url:
```
  Note: If you do not provide the environment name the following message is displayed:
```
ocli context new
Enter context name:
```
  You must enter a valid name to continue.
2. Enter the host and port name separated by a colon (:)
```
ocli context new TEST
Enter url:
localhost:8080
```
  A confirmation message is displayed to indicate the creation of the new context.
```
ocli context new TEST
Enter url:
localhost:8080
You have successfully added the TEST context.
```
  Note: If you enter http or https as port, the default values 80 and 443 are respectively added to the config.yaml file.
Follow the below steps to create the LOCAL context with localhost and 9433 as host and port respectively.
1. Enter the command
```
ocli context new LOCAL
```
  The following message is displayed to add host and port name
```
ocli context new LOCAL
Enter url:
```
2. Enter the url as https://localhost:9433/:
```
ocli context new TEST
Enter url:
https://localhost:9433/
```
  A confirmation message is displayed to indicate the creation of the new context.
```
ocli context new TEST
Enter url:https://localhost:9433/
You have successfully added the LOCAL context.
```
  Note: If you enter http or https as URL and did not add any specific value as port, the default values 80 and 443 are respectively added to the config.yaml file.