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.
Plan commands
You can use the plan commands to submit and run the task or workflows.
kill
You can use the kill command to stop a task in progress.

What's new
HCL Universal Orchestrator is constantly evolving to offer you the most comprehensive orchestration capabilities. For known limitations, workarounds, and contact information of HCL Customer Support, see Release notes.
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
All the information you need to deploy and administrate HCL Universal Orchestrator.
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.
  - Plan commands
    You can use the plan commands to submit and run the task or workflows.
    - adddep job
      You can use the command option to add dependencies to a task.
    - adddep sched
      You can use the adddep sched command to add dependencies to a workflow.
    - altjob
      You can use the altjob command to modify a task in plan before it starts running.
    - altpass
      You can use the altpass command to change the password of a credential or user.
    - altpri
      You can use the altpri command to change the priority for a task or workflow.
    - cancel job
      You can use the cancel job command to cancel a task.
    - cancel sched
      You can use the cancel sched command to cancel a workflow.
    - change resource
      You can use the changeresource command to update the quantity of a resource.
    - confirm
      You can use the confirm command to change the status of a task after it finishes.
    - deldep job
      You can use the deldep job command to delete the dependencies from a task.
    - deldep sched
      You can use the deldep sched command to delete the dependencies from a workflow.
    - fence
      You can use the fence command to set the priority for a workstation to filter tasks.
    - kill
      You can use the kill command to stop a task in progress.
    - limit cpu
      You can use the limit cpu command to set the number of tasks that can run simultaneously on a workstation.
    - limit sched
      You can use the limit sched command to set the number of tasks that can run simultaneously in a workflow.
    - 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 task.
    - release sched
      You can use the release sched command to release the regular and time dependencies from a workflow.
    - reply
      Workflows that contain human tasks remain in EXEC status until the assigned user provides confirmation. You can use the reply command to confirm either a specific human task or multiple tasks in one step.
    - rerun
      You can use the rerun command to rerun a task.
    - set online and set offline
      You can use one of these commands to make a workstation available or unavailable for tasks to run, or to set an event source online or offline.
    - showcpu
      You can use the showcpu command to display information about workstations.
    - showeventsource
      Event sources receive events from specific event plug-ins. You can use the showeventsource command to display details about event sources.
    - showjobs
      You can use the showjobs command to view the information about tasks.
    - show resource
      You can run the showresource command to view information about resources.
    - showsched
      You can use the showsched command to display the information about workflows.
    - submit docommand
      You can use the submit docommand command to schedule the start of a command as a task.
    - submit job
      You can use the submit job command option to start a task.
    - submit sched
      You can use the submit sched command to start a workflow.
  - 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.
- 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
- Communicating with the AI agent
- 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.
Administering multitenancy for service providers
Configure and administer a HCL Universal Orchestrator multitenant environment.
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

kill

You can use the kill command to stop a task in progress.

Overview

When you stop tasks by using the kill command, the stopped tasks are finished in the ABEND state. Tasks or workflows that are dependent on these tasks, are not released. You can later run the tasks that are in ABEND state.

Important: To run this command, you must have KILL access to the task.

Syntax and command line options

Before you run the command, you must specify the details of the command line options such as workflow name, dependencies and required permissions. you can enter the command as follows:

ocli plan kill | k jobselect [;noask]

The details that are required with each parameters are described below.

jobselect

Specify the task to update, by using attributes and qualifiers.

For example, enter the following command WA_AGT_0#WORKFLOW.TASK.

noask: When you add the noask option as an argument, the agent does not ask for confirmation before it acts on each qualifying item.

Examples

To stop the report tasks in the apwkly(0600 03/05/06) workflow on the site3 workstation, run the following command:
```
ocli plan kill site3#apwkly(0600 03/05/06).report
```
To stop the 124 tasks that is running on the geneva workstation, run the following command:
```
ocli plan kill geneva#124
```