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.
Plug-in commands
You can use the plug-in commands to install, delete, or update plug-ins supported by HCL Universal Orchestrator.
List
You can use the list command to view information about all the installed job and event plug-ins. The command shows details such as, name, ID, type, and version of each plug-in.

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.
  - 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.
    - delete
      You can use the delete command to remove any plug-in from the database.
    - install
      You can use the install command to install a single plug-in or multiple plug-ins simultaneously.
    - List
      You can use the list command to view information about all the installed job and event plug-ins. The command shows details such as, name, ID, type, and version of each plug-in.
    - update
      You can use the update command to install higher versions of existing plug-ins or revert to an earlier version.
  - 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.

list

You can use the list command to view information about all the installed job and event plug-ins. The command shows details such as, name, ID, type, and version of each plug-in.

Syntax and command line options

You can enter the command as follows:

ocli plugin [list | l ] [plugin_name] ;[type=plugin_type] ;[version=version] ;[noid]

You can add anyone or combination of these parameters to view specific results. You must have LIST_PLUGIN access to run this command. For more information, see Access required to run Orchestration CLI commands.The details required with each parameter are as follows:

plugin_name: You can specify the plug-in name. Wildcard characters are supported.

type=plugin_type: You can specify the plug-in type. The supported values are job, event, or both, and the default value is both.

version: You can specify the version of the plug-in.

noid: When you install a plug-in, a unique ID is created for that particular plug-in. If you run the list command, the IDs for the plug-ins are also displayed. You can use the noid option with the command to display the results without these IDs.

Examples

To view all the plug-ins available in your database, run the following command:
```
ocli plugin list
```
To list the 10.2.0.00 version of ServiceNow plug-in, run the following command:
```
ocli plugin list ServiceNow type=job version=10.2.0.00
```
To list all the plug-ins without the ID, run the following command:
```
ocli plugin list @ noid
```
You can use any wildcards instead of @. Enter the plug-in name instead of @, if you want list a specific plug-in.