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.
Plan commands
You can use the plan commands to submit and run the job or job streams.
showjobs
You can use the showjobs command to view the information about jobs.
info format
You can add the info option in the showjobs command to view the information related to jobs displayed in the info format.

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.
    - adddep job
      You can use the command option to add dependencies to a job.
    - adddep sched
      You can use the adddep sched command to add dependencies to a job stream.
    - altjob
      You can use the altjob command to modify a job in plan before it starts running.
    - altpass
      You can use the altpass command to change the password of a user.
    - altpri
      You can use the altpri command to change the priority for a job or job stream.
    - cancel job
      You can use the cancel job command to cancel a job.
    - cancel sched
      You can use the cancel sched command to cancel a job stream.
    - confirm
      You can use the confirm command to change the status of a job after it finishes.
    - deldep job
      You can use the deldep job command to delete the dependencies from a job.
    - deldep sched
      You can use the deldep sched command to delete the dependencies from a job stream.
    - fence
      You can use the fence command to set the priority for a workstation to filter jobs.
    - kill
      You can use the kill command to stop a job in progress.
    - limit cpu
      You can use the limit cpu command to set the number of jobs that can run simultaneously on a workstation.
    - limit sched
      You can use the limit sched command to set the number of jobs that can run simultaneously in a job stream.
    - listfolder
      You can use the listfolder command to view the folders in a directory.
    - release job
      You can use the release job command to release normal and time dependencies from a job.
    - release sched
      You can use the release sched command to release the regular and time dependencies from a job stream.
    - rerun
      You can use the rerun command to rerun a job.
    - set online and set offline
      You can use one of these commands to make a workstation available or unavailable for jobs to run, or to set an event source online or offline.
    - showcpu
      You can use the showcpu command to display the information about workstations.
    - showeventsource
      You can use the showeventsource command to display information about event sources.
    - showjobs
      You can use the showjobs command to view the information about jobs.
      - info format
        You can add the info option in the showjobs command to view the information related to jobs displayed in the info format.
      - Logon format
        You can add the Logon option with the showjob command to view the information related jobs in Logon format.
      - Standard format
        If you do not specify any options with the showjobs command, the results are displayed in the standard format.
    - showschedules
      You can use the showschedules command to display the information about job streams.
    - submit docommand
      You can use the submit docommand command to schedule the start of a command as a job.
    - submit job
      You can use the submit job command option to start a job.
    - submit sched
      You can use the submit sched command to start a job stream.
  - 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.
  - 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 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.

info format

You can add the info option in the showjobs command to view the information related to jobs displayed in the info format.

The following details are displayed in the info format. The performed command and credential details, such as user name and password are also displayed.

Workstation: The workstation on which the job runs.

Job Stream: The name of the job stream.

SchedTime: The date and time on which the job is scheduled to run. The date is displayed in mm/dd format.

job

The job name. The notation described in the following list might precede the job name.

rerun as
The job that was rerun by using the rerun command.
rerun step
The job that was rerun by using the rerun;step command.

Job File: The name of the script or the executable file of the job.
Note: File names that are too long might wrap, resulting in incorrect paging. You can use the more option to have a clear view of the results that are displayed.

Example

Run the following command:

ocli plan sj WS_AGT_0#JOBPROVA_JOBS.JOBPROVA info

The result is displayed as follows:

Workstation      Job Stream       SchedTime  Job                                    JobFile
WS_AGT_0        #JOBPROVA_JOBS   1425 03/24
                                             JOBPROVA
    ---
    executable:
      script: ls
      credential:
        userName: trvuser
        password: "${password:trvuser}"