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.
help
You can use the help command to view the online help or details about the commands that Orchestration CLI supports.

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.
  - 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.
  - 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. You can use the command either with a plan or a model.
  - 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 matching criteria
  In this topic you can find a description of matching criteria.
- 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.
- Data exchange and transformation
  This topic explains how you can streamline your workflows using data exchange and transformation.

help

You can use the help command to view the online help or details about the commands that Orchestration CLI supports.

Overview

You can use the help command alone or in combination with parameters to achieve specific results. You can use the command either with a plan or a model.

Syntax and command line options

You can enter the command as follows:

ocli [model|plan] help | h <command>

To view the details of a specific command, add the command parameter.

Command: You can specify the command name to view details about it. You must enter the spelled-out form of the command. No abbreviations are supported. You can enter the first word of a command and online help of all commands that begin with that word is displayed.

Examples

Run the following command to display the list of Orchestration CLI commands:
```
ocli [plan|model] help commands
```
Run the following command to view the details of display command:
```
ocli model help display
```
Run the following command to view the details of cancel job and cancel sched command:
```
ocli plan help cancel
```