HCL Workload Automation, Version 9.4

Parameters and arguments

About this task

–new
The –new parameter configures HCL Workload Automation on all the nodes of the cluster or on a new cluster node. It takes the following arguments:
Domain=<Windows_domain>
The Windows User Domain of the HCL Workload Automation User. This parameter is mandatory if –new or –uninst is specified. This parameter must not be specified in double-byte character set (DBCS) characters.
user=<TWS_user>
The Windows User Name of the HCL Workload Automation User. This parameter is mandatory if –new or –uninst is specified. This parameter must not be specified in double-byte character set (DBCS) characters.
pwd=<TWS_user_password>
The Windows password of the HCL Workload Automation user. This parameter is mandatory if –new is specified.
hosts=<hostname1,hostname2...>
The host names of the cluster nodes where you want to configure HCL Workload Automation. Host names must be separated by commas. This parameter is optional. It can be used to configure a new joining node of the cluster.
twshome=<TWS_home_directory>
The directory where HCL Workload Automation is installed. This parameter is optional. If you do not specify this directory, the command discovers the installation directory.
–res
The –res parameter adds a new instance of the HCL Workload Automation resource type to an existing cluster group. It takes the following arguments:
group=<cluster_group_name>
The name of the group (Virtual Server) where HCL Workload Automation is configured as the cluster resource. This parameter is mandatory.
ip=<IP_resource_name>
The name of the cluster IP resource type that the HCL Workload Automation resource depends on. This parameter is mandatory.
net=<network_resource_name>
The name of the network resource type that the HCL Workload Automation resource depends on. This parameter is mandatory.
disk=<disk_resource_name>
The name of the disk resource type that the HCL Workload Automation resource depends on. This parameter is mandatory.
resname=<resource_instance_name>
The name of the resource instance, as it appears in the Cluster Administrator (see Figure 1). If this parameter is not supplied, the default value of ITWSWorkstation_<domain_name>_<user_name> is used.
failover=yes|no
If you specify yes, HCL Workload Automation can cause the failover of the virtual server group. If you do not specify this option HCL Workload Automation will not cause the failover of the virtual server group. This parameter is optional. Note that you can modify this setting directly from the Cluster Administrator console. Modifying the threshold and period values from the resource property tab you can enable or disable the automatic failover in case of resource failure. See the Windows Cluster Guide for more information.
check_interval=<TWS_polling_interval>
The interval in milliseconds that the HCL Workload Automation resource waits between two health checks. This parameter is optional. Use values greater than 60000. The default value is 100000. You can change this value from the Cluster Administrator console: right-click the resource and select Properties → Parameters.
lookalive=<lookalive_interval>
The interval in milliseconds at which the Cluster service polls the resource to determine if it appears operational. This parameter is optional. Use values greater than 10000. The default value is 10000. You can change this value from the Cluster Administrator console: right-click the resource and select Properties → Advanced.
Isalive=<isalive_interval>
The interval in milliseconds at which the Cluster service polls the resource to determine if it is operational. This parameter is optional. Use values greater than 10000. The default value is 60000. You can change this value from the Cluster Administrator console: right-click the resource and select Properties → Advanced.
tcpport=tcp_port
This parameter is reserved for future use.
opts=generic_options
The opts parameter is used to specify a set of options. Each option is separated by a semicolon ";". The opts parameter accepts the following options:
  • Monitoring options:
    • ftaOff

      Monitoring option: use this option to disable monitoring (and failover) of fault-tolerant agents.

    • lwaOn

      Monitoring option: use this option to enable monitoring (and failover) of dynamic agents.

      For details about the monitoring options in your cluster environment, see Table 1.
      Table 1. Monitoring options in your cluster environment.
      Types of HCL Workload Automation agent installation in your cluster environment Monitoring options for your agent installation Result
      • Agent installation composed of both fault-tolerant agent and dynamic agent
      • Agent installation composed of fault-tolerant agent only
      		 No options are specified Only fault-tolerant agent is monitored (default).
      opts=lwaOn;ftaOff Only dynamic agent is monitored.
      opts=lwaOn Both fault-tolerant agent and dynamic agent are monitored.
      opts=ftaOff Neither fault-tolerant agent nor dynamic agent are monitored.
      • Agent installation composed of dynamic agent only
      		 No options are specified Dynamic agent is monitored (default).
      opts=lwaOn;ftaOff Dynamic agent is monitored.
      opts=lwaOn Dynamic agent is monitored.
      opts=ftaOff Dynamic agent is monitored.
  • killjob

    Use this option to kill any job (and job child) running at the moment of the resource failure.

  • link=<parent_domain>!<parent_domain_manager>

    Use this option if you are configuring a cluster-aware domain manager. Specify the parent domain and manager of the agent you are configuring.

    For example if you are configuring a domain manager which is a child of the master domain manager (named MyMasterWS in the domain MASTERDOM), the value to specify is link=MASTERDOM!MyMasterWS.

The kill and the link options can be used together (for example, opts=killjob;link=MASTERDM!MASTERWS;). You can change this value from the Cluster Administrator console: right-click the resource and select Properties → Parameters. Change the values in the genericOpts field.
–dll
The –dll parameter specifies that the ITWSResources.dll that implements the new HCL Workload Automation resource type needs to be installed. This parameter is mandatory the first time you configure HCL Workload Automation on the cluster or if a new node is joining the cluster. This parameter takes one optional argument:
[path=<DLL_resource_path>]
The path where the ITWSResources.dll must be installed. This parameter is optional. If you do not specify the path, the default value, \%systemRoot%\cluster, is used. Do not specify the drive letter for the path. The path specified must exist and must be accessible on each node of the cluster.
–force
The –force parameter optionally forces the installation of the HCL Workload Automation resource DLL (ITWSResources.dll) without checking the version. The parameter is ignored if you did not specify the –dll parameter.
–sharedDesktop
The –sharedDesktop parameter optionally specifies that Jobmon uses a shared desktop name to manage desktop heap memory allocation where multiple agents are installed on one computer (see Resolving desktop heap size problems on workstations with more than three agents for details). Use the same name for at least two agents on this computer to make the option effective.
name=<desktop_name>
The optional desktop name. If you supply a name, it must be in single-byte characters (English alphabet), with no special characters allowed, except spaces, in which case you must surround it by double quotes. The default name (by not supplying the name=<desktop_name> argument), is TWS_JOBS_WINSTA.

–uninst
The –uninst parameter uninstalls the cluster resource instance, and accepts the following arguments:
Domain=<Windows_domain>
The Windows User Domain of the HCL Workload Automation User. This parameter is mandatory if you specify –new or –uninst. This parameter must not be specified in double-byte character set (DBCS) characters.
user=<TWS_user>
The Windows User Name of the HCL Workload Automation User. This parameter is mandatory if you specify –new or –uninst. This parameter must not be specified in double-byte character set (DBCS) characters.
hosts=<hostname1,hostname2...>
The host names of the cluster nodes where you want to uninstall HCL Workload Automation. Host names have to be separated by commas. This parameter is optional. If you do not specify this parameter, HCL Workload Automation is uninstalled from all nodes in the cluster except for the current node.
–update
The –update parameter updates the HCL Workload Automation resource DLL of an existing instance, and accepts the following arguments:
resource=<resource_instance_name>
The HCL Workload Automation Resource Instance name as it appears within the cluster group. The default name is ITWSWorkstation_<domain>_<user>. This parameter is mandatory.
ask={yes|no}
Define if the resource DLL upgrade can be performed automatically. Supply yes to ask that the resource upgrade is performed automatically, if the upgrade version is greater than the actual version or - force parameter is provided. Supply no to ask that the resource is not upgraded. This parameter is optional. If it is not specified, the installation stops and, in case the upgrade version is greater than the actual version or - force parameter is provided, asks the operator to confirm the resource DLL upgrade and the restart of the related cluster resource.
–force
Force the installation of the HCL Workload Automation resource DLL (ITWSResources.dll) without checking the version. This parameter is optional.
–twsupd
Define whether to update the Windows service registry after updating the resource DLL. Use this parameter only when updating the DLL after upgrading HCL Workload Automation to a new major version, such as 9.4. This parameter is optional.
hosts=<hostname1,hostname2...>
The host names of the cluster nodes on which you want to update HCL Workload Automation. Host names have to be separated by commas. This parameter is optional. If you do not specify this parameter, HCL Workload Automation is updated on all nodes in the cluster.
–changeResName
The –changeResName parameter changes the cluster instance resource name, and accepts the following arguments:
"<resource_instance_name>"
The HCL Workload Automation Resource Instance name as it appears within the cluster group. The default name is ITWSWorkstation_<domain>_<user>. This argument is mandatory for –changeResName.
"<new_resource_instance_name>"
The new name you want to use for the HCL Workload Automation resource instance. This argument is also mandatory for –changeResName.