Remote command jobs
A remote command job runs on remote computers that are not required to have the HCL Workload Automation agent installed.
A description of the job properties and valid values are detailed in the context-sensitive help in the Dynamic Workload Console by clicking the question mark (?) icon in the top-right corner of the properties pane.
Note: On Windows systems, the RemoteCommand plug-in has a hardcoded timeout set to
5 minutes (300 seconds). It might happen that this timeout is reached when a job is still running,
causing its abnormal ending. To prevent this, a new property file,
RemoteCommandExecutor.properties
, has been added to the plug-in, having the
attribute timeout that can be set to a different amount of seconds to give more time to run
to the job. The attribute format is as follows: timeout=sec, where sec is the
amount of time in seconds. Restart the agent to make this change effective.Note: A Remote Command job that runs on a Windows workstation that is configured to use the samba
protocol version 2 or 3, without an active SSH server, fails.
This section describes the required and optional
attributes for remote command jobs.
Each job definition has the following format and arguments:
Attribute | Description/value | Required |
---|---|---|
application name | remotecommand | ✓ |
userName |
The user name authorized to start a connection
on the remote computer using the defined protocol. As an alternative
to hard-coding actual values, you can parametrize in one of the following
ways:
|
✓ |
password | The password of the authorized user. The password is encrypted when the job is created. See description for userName for more details. | |
server name | The host name of the computer where the remote command instance is running. | ✓ |
port | The port number of the remote computer where the command runs. | ✓ |
protocol | Possible values:
|
|
keystore file path | The fully qualified path of the keystore file containing the private key used to make the connection. A keystore is a database of keys. Private keys in a keystore have a certificate chain associated with them which authenticates the corresponding public key on the remote server. A keystore also contains certificates from trusted entities. Applicable to SSH protocol only. | |
keystore password | The password that protects the private key and is required to make the connection. This attribute is required only if you specify a keystore file path. If the keystore file path and keystore password combination fail to make a connection, then an attempt is made using the userName and password that correspond to the user authorized to start a connection on the remote computer. | ✓ |
command | Type the command to be submitted on the remote computer. | ✓ |
environment | The standard output and standard error files
for the remote command.
These files are located on the agent, not locally on the workstations
where the remote command runs.
Ensure you have write rights on the specified directories, otherwise
no file will be created.
|
The following example shows the JSDL “application” section of a sample job
definition for a remote command
job:
$JOBS
NC112016#REMCMD
TASK
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl"
xmlns:jsdlremotecommand="http://www.ibm.com/xmlns/prod/scheduling/1.0/
<jsdlremotecommand" name="REMOTECOMMAND">
<jsdl:application name="remotecommand">
<jsdlremotecommand:remotecommand>
<jsdlremotecommand:RemoteCommandParameters>
<jsdlremotecommand:taskPanel>
<jsdlremotecommand:command>ping -c 10 localhost </jsdlremotecommand:command>
</jsdlremotecommand:taskPanel>
<jsdlremotecommand:environmentPanel>
<jsdlremotecommand:standardOutput>stdout</jsdlremotecommand:standardOutput>
<jsdlremotecommand:standardError>stderr</jsdlremotecommand:standardError>
</jsdlremotecommand:environmentPanel>
<jsdlremotecommand:serverPanel>
<jsdlremotecommand:serverInfo>
<jsdlremotecommand:serverName>9.168.112.16</jsdlremotecommand:serverName>
<jsdlremotecommand:port>23</jsdlremotecommand:port>
<jsdlremotecommand:protocol>ssh</jsdlremotecommand:protocol>
</jsdlremotecommand:serverInfo>
<jsdlremotecommand:credentials>
<jsdl:userName>userName</jsdl:userName>
<jsdl:password>{aes}mv0GJqOHWo8lbuhcpFaluL9RkGQKrYvTiAUpKTMgp90=
</jsdl:password>
</jsdlremotecommand:credentials>
<jsdlremotecommand:certificates>
<jsdlremotecommand:keystoreFilePath>/var/keyStoreFile</jsdlremotecommand:
keystoreFilePath>
<jsdlremotecommand:keystorePassword>pwd</jsdlremotecommand:keystorePassword>
</jsdlremotecommand:certificates>
</jsdlremotecommand:serverPanel>
</jsdlremotecommand:RemoteCommandParameters>
</jsdlremotecommand:remotecommand>
</jsdl:application>
</jsdl:jobDefinition>
RECOVERY STOP
See also
From the Dynamic Workload Console you can perform the same task as described in
For more information about how to create and edit scheduling objects, see