Welcome
IBM® Workload Scheduler
Welcome to the IBM® Workload Scheduler documentation, where you can find information about how to install, maintain, and use IBM Workload Scheduler. The documentation has been updated for IBM Workload Scheduler Version 10.2.3.
User's Guide and Reference
Orchestration CLI
The command line interface to run jobs or job streams and to interact with IBM® Workload Scheduler.
Authenticating Orchestration CLI using API Keys
When you connect to IBM® Workload Scheduler using Orchestration CLI for the first time, you need to authenticate the connection using API Keys.

Product requirements
This section contains links to the IBM® Workload Scheduler Download Documents, System Requirements, and Release Notes.
Product Library in PDF format
This section contains links to the PDF versions of all the publications provided in IBM Documentation for IBM Workload Automation.
Considerations for GDPR readiness
Overview
Mobile Applications Userʼs Guide
Dynamic Workload Console User's Guide
AI Data Advisor (AIDA) User's Guide
Scheduling Job Integrations with IBM Workload Automation
IBM® Workload Scheduler
Welcome to the IBM® Workload Scheduler documentation, where you can find information about how to install, maintain, and use IBM Workload Scheduler. The documentation has been updated for IBM Workload Scheduler Version 10.2.3.
- Quick Start Guide
- Planning and Installation
- User's Guide and Reference
  - IBM Workload Scheduler
  - Understanding basic processes and commands
  - Configuring the job environment
  - Managing the production cycle
  - Using workload service assurance
    Workload service assurance is an optional feature that provides the means to flag jobs as mission critical for your business and to ensure that they are processed in a timely manner. Using this function benefits your scheduling operations personnel by enhancing their ability to meet defined service levels.
  - Customizing your workload using variable tables
    This chapter introduces the concept of variable tables to group global parameters, from now on called variables, to customize your workload.
  - Condition-based workload automation
  - Running event-driven workload automation
  - Defining objects in the database
  - Managing objects in the database - composer
  - Managing workload applications
    Workload applications can be created and then exported so that they can be shared with other IBM Workload Scheduler environments. In the new environment, the workload application can be subsequently updated, replaced, or deleted.
  - Managing objects in the plan - conman
  - Using Orchestration Query Language from command line
    You can use the essential Orchestration Query Language keywords and syntax to effectively write queries from command line.
  - Orchestration CLI
    The command line interface to run jobs or job streams and to interact with IBM® Workload Scheduler.
    - Configuring Orchestration CLI
      The extension for Orchestration CLI is bundled with the product. If required, you can download it as a stand-alone feature also.
    - Running commands from Orchestration CLI
      After you installed and configured the Orchestration CLI, you can run one or a combination of commands to accomplish specific results.
    - Authenticating Orchestration CLI using API Keys
      When you connect to IBM® Workload Scheduler using Orchestration CLI for the first time, you need to authenticate the connection using API Keys.
    - 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.
    - version
      You can use the version command to view the version of Orchestration CLI that is installed in your system.
    - 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
    - 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.
  - Monitoring IBM® Workload Scheduler
    Using internal and third-party tools to monitor IBM® Workload Scheduler
  - Extending IBM Workload Scheduler capabilities
    You can extend IBM Workload Scheduler capabilities by integrating with third-party products. This integration allows you to easily start IBM Workload Scheduler jobs on external products, while using IBM Workload Scheduler scheduling capabilities. IBM Workload Scheduler also provides jobs that perform everyday operations, such as file transfer and web services, and utility jobs that automate and simplify operations, such as the job stream submission.
  - Managing dynamic scheduling
    This section explains how you can manage dynamic scheduling capabilities in your environment to schedule both existing IBM Workload Scheduler jobs and job types with advanced options, both those supplied with the product and the additional types implemented through the custom plug-ins.
  - Using utility commands
  - Using utility commands in the dynamic environment
  - Getting reports and statistics
  - Managing time zones
  - Defining access methods for agents
  - Managing internetwork dependencies
  - Applying conditional branching logic
    With IBM® Workload Scheduler you can define jobs to run when and as often as necessary. Sometimes some jobs might have to wait for other jobs to finish successfully before they start. Add even more flexibility to your job flows by choosing which job to run depending on the result of the job status or output of a previous job. Whenever you have conditions that specify whether or not a segment of your job flow should run, then that is a conditional dependency.
  - Defining and managing cross dependencies
  - Managing an IBM i dynamic environment
  - Event-driven workload automation event and action definitions
  - Quick reference for commands
  - Accessibility
- Administration Guide
- Scheduling with the Agent for z/OS
- Database Views
- High Availability Cluster Environment
- Troubleshooting
- Driving IBM Workload Automation
- Extending IBM Workload Automation
IBM® Z Workload Scheduler
Welcome to the IBM® Z Workload Scheduler documentation, where you can find information about how to install, maintain, and use the product.
Messages and Codes
Glossary
Notices

Authenticating Orchestration CLI using API Keys

When you connect to IBM® Workload Scheduler using Orchestration CLI for the first time, you need to authenticate the connection using API Keys.

Before you begin

You must have completed the following tasks:

Downloaded the package for Orchestration CLI.
Created valid credentials in an authentication or authorization provider that uses the open protocol standard OpenID Connect.
Configured IBM® Workload Scheduler to specify the instance where the authentication or authorization provider is running. For more information, see Configuring a user registry.

Procedure

Navigate to the directory where you have downloaded the files for Orchestration CLI.
Run Orchestration CLI from the command line.

Note: For windows, you can also use powershell to run the file.
Type any Orchestration CLI command.
Example:
```
ocli model list folder @
```
An error message with a web link to create the API Key is displayed.
Open the web link using any web browser.

The login page of the authentication provider that you configured is displayed.
Enter the username and password for the authorization provider.

A message is displayed to indicate that the API Key has been successfully generated. This API Key gets automatically updated in the config.yaml file.

Results

You have successfully established a connection with IBM® Workload Scheduler from Orchestration CLI.

What to do next

You can fill in other mandatory fields in the config.yaml file and if already done, you can run any Orchestration CLI commands to achieve specific results. For more information, see Running commands from Orchestration CLI.