In a Tivoli® Workload Scheduler network, a workstation is a scheduling object that runs jobs. You create and manage the scheduling object workstation in the Tivoli Workload Scheduler database by means of a workstation definition. A workstation definition is required for every object that runs jobs. Typically, a workstation definition is used to represent a physical workstation but, in the case of extended agents for example, it represents a logical definition that must be hosted by a physical workstation.
You can include multiple workstation definitions in the same text file, together with workstation class definitions and domain definitions. A workstation definition has the following syntax:

cpuname workstation [description "description"]
[vartable table_name]
os os-type
[node hostname] [tcpaddr port]
[secureaddr port] [timezone|tz tzname]
[domain domainname]
[for maestro [host host-workstation [access method | agentID agentID ]]
[type fta | s-agent | x-agent | manager | broker |
agent
|
rem-eng
|
pool
|
d-pool
]
[ignore]
[autolink on | off]
[behindfirewall on | off]
[securitylevel enabled | on | force]
[fullstatus on | off]
[server serverid]]
[protocol http | htpps]
[members [workstation] [...]]
[requirements jsdl_definition]]
end
[cpuname ...]
[cpuclass ...]
[domain ...]


You can include multiple workstation definitions in the same text file, together with workstation class definitions and domain definitions. A workstation definition has the following syntax:

| Attributes | Master domain manager | Domain manager | Backup domain manager |
|---|---|---|---|
| cpuname | The name of the workstation. | ||
| description | A description for the workstation enclosed within double quotes. This attribute is optional. | ||
| vartable | The name of a variable table associated with the workstation. Variables used with the workstation are defined in this table. This attribute is optional. | ||
| os | The operating system installed
on the system. Specify one of the following values: UNIX |
||
| node | The system host name or IP address. | ||
| tcpaddr | The value assigned to nm port in the localopts file. For multiple workstations on a system, enter an unused port number. The default value is 31111. | ||
| secureaddr | The value assigned to nm ssl port in the localopts file. Specify it if securitylevel is set to on, force or enabled. | ||
| timezone | tz | The time zone in which the system is located. It is recommended that the value matches the value set on the operating system. | ||
| domain | MASTERDM | The name of the managed domain. | |
| host | Not applicable | ||
| access | Not applicable | ||
| type | manager | fta | |
| ignore | Use this attribute if you do not want this workstation to appear in the next production plan. | ||
| autolink | It indicates if a link between
workstations is automatically opened at startup. Specify one of the
following values: ON |
||
| behindfirewall | This setting is ignored. | It indicates if there is a firewall
between the workstation and the master domain manager. Specify one
of the following values: ON |
|
| securitylevel | The type of SSL authentication
to use: enabled |
||
| fullstatus | ON | ||
| server | Not applicable | This setting is ignored. | |
| protocol | Not applicable | ||
| members | Not applicable | ||
| requirements | Not applicable | ||

Table 2 describes the values you set for each attribute for target workstation types. Following the table you find additional details about each attribute.

| Attribute | Fault-tolerant agent and standard agent | Workload broker workstation | Extended agent | Agent | Remote engine workstation | Pool | Dynamic pool |
|---|---|---|---|---|---|---|---|
| cpuname | The name of the workstation. | ||||||
| description | A description for the workstation enclosed within double quotes. This attribute is optional. | ||||||
| vartable | The name of a variable table associated with the workstation. Variables used with the workstation are defined in this table. This attribute is optional. | ||||||
| os | The operating system installed on the system.
Specify one of the following values: UNIX Specify OTHER for IBM isystems running as limited fault-tolerant agents. |
OTHER | The operating system installed on the machine.
Specify one of the following values: UNIX |
This value setting is discovered on the system. | The operating system installed on the machine.
Specify one of the following values: UNIX |
The operating system installed
on the machine. Specify one of the following values: UNIX |
|
| node | The system host name or IP address. | The system host name or IP address. Specify NULL when host is set to $MASTER, or when defining an extended agent for PeopleSoft, SAP or Oracle. | Agent host name or IP address. | Remote engine host name or IP address. | Not applicable | ||
| tcpaddr | The value assigned to nm port in the localopts file. When defining multiple workstations on a system, enter an unused port number. The default value is 31111. | The value assigned to nm port in the localopts file. When defining multiple workstations on a system, enter an unused port number. The default value is 41114. | See the selected access method specifications. | The port number to communicate with the agent when the protocol is http. | The port number to communicate with the remote engine when the protocol is http. | Not applicable | |
| secureaddr | The value assigned to nm ssl port in the localopts file. Specify it if securitylevel is set to on, force or enabled. | Not Applicable | Not Applicable | The port number to communicate with the agent when the protocol is https. | The port number to communicate with the remote engine when the protocol is https. | Not applicable | |
| timezone | tz | The time zone in which the system is located. It is recommended that the value matches the value set on the operating system. | The time zone set on the workstation specified in the host attribute. | The time zone set on the agent. | The time zone set on the remote engine. | The time zone set on the pool agents. | The time zone set on the dynamic pool agents. | |
| domain | Specify an existing domain. The default value for fault-tolerant agents is MASTERDM. This setting is mandatory for standard agents. | Specify an existing domain. This setting is mandatory. | This setting is needed only if the value assigned to host is $MANAGER. | Not applicable | |||
| host | Not Applicable | The host workstation. It can be set to $MASTER or $MANAGER. | The broker workstation. | ||||
| access | Not Applicable | Select the appropriate access method file name. | Not Applicable | ||||
agentID![]() |
The unique identifier of the dynamic agent![]() |
||||||
| type | fta Specify fta for IBM isystems running as limited fault-tolerant agents. |
broker | x-agent | agent | rem-eng | pool | d-pool |
| ignore | Use this attribute if you do not want this workstation to appear in the next production plan. | ||||||
| autolink | It indicates if a link between
workstations is automatically opened at startup. Specify one of the
following values: ON |
OFF | Not applicable | ||||
| behindfirewall | It indicates if there is a firewall
between the workstation and the master domain manager. Specify one
of the following values: ON |
OFF | Not applicable | ||||
| securitylevel | The type of SSL authentication to use: enabled |
Not Applicable | |||||
| fullstatus | It indicates if the workstation is updated about
job processing status in its domain and subdomains. Specify one of
the following values: ON |
OFF | Not applicable | ||||
| server | 0-9, A-Z. When specified, it requires the creation of a dedicated mailman processes on the parent workstation. | Not Applicable | |||||
| protocol | Not applicable | Specify one of the following
values: http |
Not applicable | ||||
| members | Not applicable | Required value | Not applicable | ||||
| requirements | Not applicable | Required value | |||||

The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. It can contain up to 16 characters.
Do not use in this field any of the reserved words specified in Table 2
The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. It can contain up to 80 characters.
IBM_i
For supported IBM i operating systems.
For host names, valid characters are alphanumeric, including dash (-). The maximum length is 51 characters.
If you are defining a remote engine workstation, specify the host name of the system where the remote engine is installed.
The default value for this field is 31111. Specify a value in the range from 1 to 65535.
If securitylevel is specified, but this attribute is missing, the default value for this field is 31113. Specify a value in the range from 1 to 65535.
See the IBM® Tivoli Workload Scheduler Administration Guide for information about SSL authentication and local options set in the TWS_home/localopts configuration file.When used in remote engine workstation definitions it represents the time zone set on the Tivoli Workload Scheduler remote engine.
See Managing time zones for valid time zone names.
Tivoli Workload Scheduler ignores domain setting when defined for extended agents, except when the host attribute is set to $MASTER.
This setting is mandatory for standard agent and dynamic workload broker workstations.
host host-workstation
This attribute
is mandatory for extended agents and remote engine workstations and
specifies:
Specify NULL when defining an extended agent for PeopleSoft, SAP, or Oracle.
agentID agentID
The unique identifier of the dynamic agent.
You must specify fta if you want to assign the workstation the role of backup domain manager or backup master domain manager.
Specify fta for IBM isystems running as limited fault-tolerant agents.
For more information, see IBM Tivoli Workload Scheduler for Applications.
For more information about the dynamic agent and Tivoli Workload Scheduler for z/OS agent, see Scheduling Workload Dynamically. For more information about the agent for z/OS, see Scheduling with the agent for z/OS.
agent
If you define a dynamic agent, that is a workstation
that manages a wide variety of job types, for example, specific database
or file transfer jobs, in addition to traditional job types. It is
hosted by the workload broker workstation. The workstation definition is automatically created and registered
when you install the dynamic agent component. In its definition you
can edit only the following attribute: 
rem-eng
If
you define a remote engine workstation, that is a workstation
used to communicate with a remote engine when binding a locally defined
job, named shadow job, to a specific job running on the remote
engine, named remote job. When the two jobs are bound, the
shadow job status transition maps the remote job status transition.
This mapping is useful also to define and monitor dependencies of
local jobs on jobs running on the remote engine; such dependencies
are called cross dependencies. For more information on shadow jobs and cross dependencies, see Defining and managing cross dependencies.

d-pool
If you define a dynamic pool, that is a set of dynamic agents
which is dynamically defined based on the requirements listed in the
JSDL file specified in the resources attribute. This workstation
is hosted by the workload broker workstation. In its definition you can edit only the following attributes:
This setting is particularly useful when a new production plan is created on the master domain manager: As part of the production plan generation all workstations are stopped and then restarted. For each agent with autolink turned on, the domain manager automatically sends a copy of the new production plan and then starts the agent. If autolink is turned on also for the domain manager, the agent opens a link back to the domain manager.
If the value of autolink is off for an agent, you can open the link from its domain manager by running the conman link command on the agent's domain manager or the master domain manager.
Set this attribute to off if you are defining a workstation with type broker.
securitylevel
If this attribute is omitted, the workstation is not configured for SSL connections and any value for secureaddr is ignored. Make sure, in this case, that the nm ssl port local option is set to 0 to ensure that netman process does not try to open the port specified in secureaddr. See the IBM Tivoli Workload Scheduler Administration Guide for information about SSL authentication.
| Value set on the Fault-tolerant Agent (or the Domain Manager) | Value set on its Domain Manager (or on its Parent Domain Manager) | Type of connection established |
|---|---|---|
| Not specified | Not specified | TCP/IP |
| Enabled | Not specified | TCP/IP |
| On | Not specified | No connection |
| Force | Not specified | No connection |
| Not specified | On | TCP/IP |
| Enabled | On | TCP/IP |
| On | On | SSL |
| Force | On | SSL |
| Not specified | Enabled | TCP/IP |
| Enabled | Enabled | TCP/IP |
| On | Enabled | SSL |
| Force | Enabled | SSL |
| Not specified | Force | No connection |
| Enabled | Force | SSL |
| On | Force | SSL |
| Force | Force | SSL |
If you are defining a fault-tolerant agent that can work as backup domain manager, the ServerID is used only when the workstation works as afault-tolerant agent; the setting is ignored when the workstation works as a backup domain manager.
Within the ServerID, the ID is a single letter or a number (A-Z and 0-9). The IDs are unique to each domain manager, so you can use the same IDs in other domains without conflict. A specific ServerID can be dedicated to more than one fault-tolerant agent workstation.
protocol http | https
Specifies the protocol to use to communicate with:
members [workstation] [...]
Use this value for a pool workstation to specify the dynamic agents that you want to add to the pool.
requirements jsdl_definition
Use this value for a dynamic pool workstation to specify
the requirements, in .JSDL format, the agents must satisfy to automatically
belong to the dynamic pool. You use the following syntax:jsdl_definition: <jsdl:resources> <jsdl:logicalResource subType="MyResourceType"/> </jsdl:resources>For more information about JSDL syntax, see Scheduling Workload Dynamically.


cpuname hdq-1 description “Headquarters master DM”
os unix
tz America/Los_Angeles
node sultan.ibm.com
domain masterdm
for maestro type manager
autolink on
fullstatus on
end
cpuname hdq-2
os wnt
tz America/Los_Angeles
node opera.ibm.com
domain masterdm
for maestro type fta
autolink on
end
domain distr-a
manager distr-a1
parent masterdm
end
cpuname distr-a1 description “District A domain mgr”
os wnt
tz America/New_York
node pewter.ibm.com
domain distr-a
for maestro type manager
autolink on
fullstatus on
end
cpuname distr-a2
os wnt
node quatro.ibm.com
tz America/New_York
domain distr-a
for maestro type s-agent
end
cpuname ENNETI3
os WNT
node apollo
tcpaddr 30112
secureaddr 32222
for maestro
autolink off
fullstatus on
securitylevel on
end
The following example
creates a broker workstation. This workstation manages the lifecycle
of Tivoli Workload Scheduler workload broker type jobs in dynamic workload broker. cpuname ITDWBAGENT
vartable TABLE1
os OTHER
node itdwbtst11.ibm.com TCPADDR 41114
timezone Europe/Rome
domain MASTERDM
for MAESTRO
type BROKER
autolink OFF
behindfirewall OFF
fullstatus OFF
end

The following example
creates a remote engine workstation to use to manage cross dependencies
and communicate with a remote engine installed on a system with hostname London-hdq using the default HTTPS port 31116. The remote
engine workstation is hosted by the broker workstation ITDWBAGENTcpuname REW_London
description "Remote engine workstation to communicate with London-hdq"
os WNT
node London-hdq secureaddr 31116
timezone Europe/London
for maestro host ITDWBAGENT
type rem-eng
protocol HTTPS
end

The following example
shows how to create a dynamic pool of dynamic agents. All dynamic agents in the dynamic pool must have the HP-UX or Linux operating
systems installed: CPUNAME DPOOLUNIX
DESCRIPTION "Sample Dynamic Pool Workstation"
VARTABLE table1
OS OTHER
TIMEZONE Europe/Rome
FOR MAESTRO HOST MAS86MAS_DWB
TYPE D-POOL
REQUIREMENTS
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:resourceRequirements
xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl">
<jsdl:resources>
<jsdl:candidateOperatingSystems>
<jsdl:operatingSystem type="HPUX"/>
<jsdl:operatingSystem type="LINUX"/>
</jsdl:candidateOperatingSystems>
</jsdl:resources>
</jsdl:resourceRequirements>
END

The following example shows how to
create a dynamic pool of dynamic agents. All dynamic agents in the dynamic pool must have the Windows 2000 operating
system installed: CPUNAME DPOOLWIN
DESCRIPTION "Sample Dynamic Pool Workstation"
OS WNT
TIMEZONE Europe/Rome
FOR MAESTRO HOST MAS86MAS_DWB
TYPE D-POOL
REQUIREMENTS
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:resourceRequirements
xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl">
<jsdl:resources>
<jsdl:candidateOperatingSystems>
<jsdl:operatingSystem type="Windows 2000"/>
</jsdl:candidateOperatingSystems>
</jsdl:resources>
</jsdl:resourceRequirements>
END

The following example shows how to
create a pool of dynamic agents with name POOLUNIX and containing two dynamic agents: NC121105 and NC117248:CPUNAME POOLUNIX
DESCRIPTION "Sample Pool Workstation"
OS OTHER
TIMEZONE Europe/Rome
FOR MAESTRO HOST MAS86MAS_DWB
TYPE POOL
MEMBERS
NC121105
NC117248
END
