Managing a workstation definition from the Orchestration CLI

In this topic you can find the syntax to manage a workstation.

When editing a scheduling item, you can define it in a folder. If no folder path is specified, then the item definition is created in the default folder.

A workstation definition has the following syntax:

Syntax

cpuname [folder/]workstation [description "description"]

[vartable table_name]
os os-type
[node ]  [timezone|tz tzname]
[for maestro  [agentID agentID ]]
     [type agent | cloud ]
     [ignore]

end

[cpuname ...]

Arguments

The following Attribute settings for target workstation types table contains a brief description of the workstation definition keywords.

Table 1. Attribute settings for target workstation types
Keyword	Description
cpuname	Using this keyword, you can specify the name of the workstation and also the name of the folder in which the workstation is defined, if any. Workstation names must be unique. The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. In this field, do not use any of the words specified in Installing command line.
description	Using this keyword, you can add a description of the workstation. The content must be enclosed within double quotation marks. To use quotation marks ("), place a backslash (\) before.
vartable table_name	Using this keyword, you can specify the name of a variable table. The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. In this field, do not use any of the words specified in Installing command line.
os	This value setting is discovered on the system.
node	Agent host name or IP address.
timezone \| tztzname	Using this keyword, you can specify the time zone to use. The time zone of the workstation and the one used on the operating system must be the same. For more information, see Managing time zones for valid time zone names.
host	The broker workstation.
agentIDagentID	Using this keyword, you can specify the identifier of the agent.
type	Using this keyword, you can specify the workstation type. Workstation types cannot be changed. You can use one of the following values: `agent` Type of workstation for a HCL Workload Automation dynamic agentconnected to HCL Universal Orchestrator Cloud task launcher The Cloud task launcher executes jobs that call external systems directly from the engine, without using an external machine. The cloud task launcher runs on a separate microservice pod and does not affect server functionalities, not impacting HCL Universal Orchestrator engine performances. For more information, see Cloud task launcher.
ignore	Specifying this setting, the workstation is removed from the plan, and the job streams defined on that workstation do not run.

Examples

The following example defines a workstation without specifying a folder:

$workstation

CPUNAME /WS_AGT_0
  DESCRIPTION "Created WS_AGT_0"
  OS UNIX
  NODE WS_AGT_0
  TIMEZONE Europe/Rome
  FOR MAESTRO
    AGENTID "ABEB9B96F4D13161B3423895A9C030B3"
    TYPE AGENT
END

The following example defines a workstation and specifies a folder in the definition:

$workstation

CPUNAME /FOLDER1/WS_AGT_FOL
  DESCRIPTION "Created WS_AGT_ FOL "
  OS UNIX
  NODE WS_AGT_ FOL
  TCPADDR 31111
  TIMEZONE Europe/Rome
  FOR MAESTRO
    AGENTID "ABEB9B96F4D13161B3423895A9C030B3"
    TYPE AGENT
END

The following example shows how to define a workstation of type Cloud task launcher:

$workstation

CPUNAME /CLOUD
  OS UNIX
  NODE CLOUD
  TIMEZONE Europe/Rome
  FOR MAESTRO
    AGENTID "01234567890123456789ABCDEFABCDEF"
    TYPE CLOUD
END