Welcome
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.
Model commands
You can use the model commands to create or modify the item definitions for folders, tasks, workflows, and other scheduling or security items.
draft/undraft
Adds the draft flag to the definition. While in draft, no definition instances are created in the plan until the draft flag is removed. You can remove them by using the undraft command.

What's new
The What's new section tracks the capabilities delivered across each HCL Universal Orchestrator release, organized by version, so you can navigate directly to the features relevant to your deployment.
Getting started with HCL Universal Orchestrator
HCL Universal Orchestrator is a cloud-native workload orchestration and scheduling platform built on Kubernetes. Its microservices-based architecture enables the centralized orchestration of multi-cloud and hybrid environments from a single point of control.
Deploying and Administrating
Deploy, connect, and administer HCL Universal Orchestrator on your own infrastructure, or start immediately with a hosted SaaS environment where the service provider manages all platform operations.
Administering multitenancy
Configure and administer a HCL Universal Orchestrator multitenant environment.
Using the UI
The UI is the HCL Universal Orchestrator interface, from which you can design your scheduling environment and monitor every process.
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, tasks, workflows, and other scheduling or security items.
    - Password encryption for model operations
      The Orchestration CLI password encryption option is a portable, user-controlled encryption mechanism that enables you to transfer credential definitions securely between different HCL Universal Orchestrator environments.
    - add
      You can use the add command to add scheduling items to the database.
    - delete
      You can use the delete command to remove the scheduling or security items from the database.
    - display
      You can use the command option to view the entire information about the item definitions of the same type.
    - draft/undraft
      Adds the draft flag to the definition. While in draft, no definition instances are created in the plan until the draft flag is removed. You can remove them by using the undraft command.
    - extract
      You can use the command option to create a text file by copying the item definitions from the database.
    - list
      You can use the list command to view the list of items of the same type.
    - listfolder
      You can use the command option to view the list of folders available in the database.
    - lock
      You can use the command option to lock access to a scheduling item definition.
    - mkfolder
      You can use the command option to create new folders.
    - modify
      You can use the command option to update the existing scheduling or security items in the database.
    - new
      You can use the new command to create a new scheduling or security item definition.
    - nop/unnop
      Sets one or more tasks in the model to an operational or non-operational state. It temporarily disables one or more tasks without changing their dependencies.
    - rename
      You can use the rename command to rename a scheduling or security item in the database.
    - renamefolder
      You can use the rename command to rename folder definitions.
    - replace
      You can use the replace command to replace the existing scheduling or security item definitions in the database.
    - rmfolder
      You can use the rmfolder command to delete folders in the database.
    - unlock
      You can use the command option to unlock a scheduling or security item that are locked.
    - Managing multiple items in a folder
      In OCLI, you can manage all or specific items in a particular folder with a single command. You can either modify or extract scheduling and security item definitions defined in the folder.
  - Plan commands
    You can use the plan commands to submit and run the task or workflows.
  - 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.
  - Recovery options
    You can use recovery options to move forward in the event of abnormal job completions and to resolve any issues efficiently, minimizing downtime. This feature ensures smooth and efficient job runs, even in the event of unexpected interruptions.
  - Orchestration CLI keywords
    You can use Orchestration CLI keywords when defining a workflows and tasks.
  - 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
- Workflow definition
  A workflow is a set of tasks to be run, together with times, priorities, and other dependencies that define the processing order.
- Task definition
  A task definition is a unit of work that specifies an action to be performed on specific workstations in the HCL Universal Orchestrator network.
- AI agent definition
  An AI agent uses a large language model (LLM) as its cognitive engine to interpret natural-language requests, break down complex goals, and make autonomous decisions.
- Cross dependencies definition
  Cross dependencies enable you to define dependencies between workflows running on different orchestration engines.
- Event source definition
  An event source is an item that allows HCL Universal Orchestrator to receive events from specific event plug-ins.
- Endpoint definition
  An endpoint is a reusable item that defines the connection parameters required to communicate with an external system.
- Calendar definition
  Calendars define the days in which workflows do or do not run.
- Folder definition
  You can use folders to organize your items accordingly to your business needs.
- Credentials definition
  Credential definitions are used to store user IDs and passwords, or tokens.
- Variable table definition
  Variables are values that can change according to the purpose of workflows and task templates.
- Run cycle group definition
  You can schedule workflows based on common run cycle groups.
- Workstation definition
  A workstation is a scheduling item that runs tasks.
- Resource definition
  A resource is an item that represents a quantifiable asset, measured in terms of units. You can add resources as dependencies in tasks or workflows.
- Event plug-in structure
- Managing matching criteria
  In this topic you can find a description of matching criteria.
- 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.
- Changing the default editor for Orchestration CLI
  To customize the editing experience in HCL Universal Orchestrator, you can modify the default editor by setting the visual or editor environment variables.
Orchestrating from Mobile
You can use your mobile devices to manage quickly and easily your whole HCL Universal Orchestrator environment.
Monitoring
Take your environment under control.
Using REST API
Use REST APIs to easily integrate workload scheduling capabilities with external products and solutions.
Uno AI Pilot
Welcome to the HCL Universal Orchestrator AI Pilot documentation. This resource is designed to guide you through everything you need to know about using UnO AI Pilot effectively. You will find detailed instructions, feature overviews, and helpful tips to ensure you get the best experience with UnO AI Pilot.
UnO Agentic AI Builder
Troubleshooting
Recover your environment if any issue occurs.
Notices

v2.1.7+draft/undraft

Adds the draft flag to the definition. While in draft, no definition instances are created in the plan until the draft flag is removed. You can remove them by using the undraft command.

Overview

When you run the command on a workflow with an active run cycle, future occurrences are suppressed. Even if you create and submit the run cycle schedule before applying the command, the command prevents all future instances from running.

You must have NOOPDB or MODIFY access to the target workflow. NOOPDB access allows you to enable or disable items, whereas MODIFY access allows you to modify all workflow properties. For more information about authorization for Orchestration CLI commands, see Access required to run Orchestration CLI commands.

Syntax and command line options

ocli model [draft/undraft] workflow_name [;noask]

You can enter the command as follows:

workflow_name: Specify the name of an existing workflow. Use wildcards to perform the action on multiple workflows.

noask: Use this optional attribute to perform the action without prompting for confirmation.

Examples

Run the following command to set the Gold_price workflow defined in WKS_AGT workstation in draft mode.
```
OCLI model draft WKS_AGT#Gold_price
```
Run the following command to restore the Gold_price workflow defined in WKS_AGT workstation.
```
OCLI model undraft WKS_AGT#Gold_price
```
Run the following command to set all workflows defined in all the folders to draft.
```
ocli model draft @#@.@
```