WA Agent for UNIX, Linux, Windows, or iSeries Agent Parameters

WA Agent for UNIX, Linux, Windows, or iSeries Agent Parameters
You can configure the following agent parameters in the agentparm.txt file. The default parameter values are set during the agent installation. You can add these parameters or can modify them as required.
3
3
agent.resourcemon.enable
Indicates whether to monitor disk space usage and report errors when thresholds are breached.
  • true
    Enables resource monitoring. You can configure the amount of available disk space the agent monitors at each threshold and can send notifications when the space is too low.
  • false
    Disables resource monitoring.
Default:
false
  • To send SNMP traps when the disk thresholds are breached, configure the agent to connect with an SNMP manager.
  • To alert the scheduling manager when a disk threshold has been breached, also set communication.managerhealthmon_n to true.
agent.resourcemon.threshold.disk.critical
Specifies the amount of disk space that is required before the agent logs a critical warning and shuts down. This parameter is applicable if agent.resourcemon.enable is set to true. This parameter uses the following syntax:
size
[B|K|M|G]
  • size
    Specifies the amount of disk space in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G).
Default:
10M
agent.resourcemon.threshold.disk.warning.notice
Specifies the amount of disk space that is required before the agent logs a warning notice. The agent continues to run and accept new job requests. This parameter is applicable if agent.resourcemon.enable is set to true. This parameter uses the following syntax:
size
[B|K|M|G]
  • size
    Specifies the amount of disk space in bytes (B), kilobytes (K), megabytes (M), or gigabytes(G).
Default:
21M or (agent.resourcemon.threshold.disk.warning.severe + 1M), whichever is greater
agent.resourcemon.threshold.disk.warning.severe
Specifies the amount of disk space that is required before the agent logs a severe warning and stops accepting new job requests. This parameter is applicable if agent.resourcemon.enable is set to true. This parameter uses the following syntax:
size
[B|K|M|G]
  • size
    Specifies the amount of disk space in bytes (B), kilobytes (K), megabytes (M), or gigabytes (G).
Default:
20M or (agent.resourcemon.threshold.disk.critical * 2), whichever is greater
Note:
The agent resumes accepting new job requests when the available disk space is greater than the size specified by this parameter.
agent.spool.success.autocleanup
Indicates whether to delete spool files automatically when the job completes successfully.
  • true
    Deletes spool files automatically when the job completes successfully.
  • false
    Does not delete spool files automatically when the job completes successfully.
Default:
false
agent.ssl.authentication.protocol
Specifies the authentication protocol for SSL.
Default:
TLS
agent.ssl.cert.selfsigned.allow
Specifies whether self-signed SSL certificates are allowed.
  • true
    Allows self-signed SSL certificates. Self-signed certificates let you create certificates for free, without having to pay a Certificate Authority (CA) or comply with any auditing requirements.
  • false
    Does not allow self-signed SSL certificates.
Default:
false
agent.ssl.keymanager.algorithm
Specifies the key manager algorithm for SSL.
Default:
SunX509
agent.ssl.keystore
Specifies the name of a keystore file for SSL. A keystore is a repository of certificates that are used for identifying a client or a server. You can generate your own keystore using the keytool utility that is provided with the JRE.
Default:
serverkeystore
agent.ssl.keystore.password
Specifies the encrypted keystore password for SSL support.
agent.ssl.reversechain
Specifies whether the chain of certificates for SSL is processed in reversed order.
    • true
      Processes the chain of certificates for SSL in reversed order.
    • false
      Process the chain of certificates for SSL in regular order.
Default:
false
agent.ssl.truststore
Specifies the name of a truststore file for SSL. The file includes trusted and client certificates.
Default:
cacerts
agent.ssl.truststore.password
Specifies the encrypted truststore password for SSL support.
agent.ssl.useacl
Specifies whether ACL is used as the authentication protocol for SSL.
    • true
      Uses ACL as the authentication protocol for SSL.
    • false
      Does not use ACL as the authentication protocol for SSL.
Default:
false
agentname
Defines the agent name. You need the agent name when you configure the scheduling manager to work with the agent.
Default:
AGENT
Limits:
Up to 16 alphanumeric characters and the special characters @, $, and underscore (_); the first character must be a letter.
Notes:
  • Because the scheduling manager uses agent names as file names, use standard file-naming conventions for your operating system.
  • For Workload Automation DE, the agent name must be in uppercase.
communication.alias_N=
<Agent Name>
The name of another CAWA Agent in your clustered environment for which you want to accept AFMs if failover occurs. You can configure numerous aliases by using the _N suffix.
communication.bindaddress=<
IP address
>
On a machine with multiple network interfaces, specifies that the agent bind itself (or listen on) one interface only, rather than bind itself to all network interfaces that are configured. Add the parameter to the agent.txt file and restart the agent.
For more details about this parameter, refer to the following article: How to Bind Workload Automation Agent to Only One IP
communication.inputport
Specifies the main port number the agent uses to listen for incoming messages from the scheduling manager. You need this port when you configure the scheduling manager to work with the agent.
Default:
7520
Limits:
1024-65534
Note:
On UNIX, ports 1 - 1023 are reserved ports, which require root access.
communication.inputport.aux
Specifies the optional auxiliary port number the agent uses to listen for incoming messages from the scheduling manager.
communication.manageraddress_
n
=
address_1
;...;
address_m
Specifies the address of the scheduling manager that the agent works with, where
n
is an integer that corresponds to the scheduling manager being configured. This value corresponds to the IP address in the connection details for the scheduling manager. You can specify a list of addresses for the scheduling manager.
Example:
172.24.36.107 (IPv4) or 0:0:0:0:0:FFFF:192.168.00.00 (IPv6)
  • You can specify a DNS name instead of the IP address for the scheduling manager. However, your agent computer must always be able to resolve the DNS name. If there is a DNS outage and your agent computer cannot resolve DNS names, the agent cannot communicate with the scheduling manager.
  • If the scheduling manager address never changes, enter the DNS name for the scheduling manager in the hosts file for your agent computer. This entry ensures that the IP address can be resolved after DNS disruptions.
communication.managerhealthmon_
n
Indicates whether to alert the scheduling manager that a disk threshold has been breached, where
n
is an integer that corresponds to the scheduling manager being configured. This parameter is applicable if resource monitoring is enabled (agent.resourcemon.enable=true).
  • true
    Sends a message to the scheduling manager when a disk threshold has been breached. A message is also sent when the notice or severe thresholds are resolved. If the critical threshold is breached, the agent sends an emergency shutdown message to indicate the reason for the shutdown.
    Note:
    If the disk situation prevents a proper shutdown, the delivery of the emergency shutdown message is not guaranteed.
  • false
    Does not send a message to the scheduling manager when a disk threshold has been breached.
Default:
false
Note:
When implemented on the scheduling manager, the scheduling manager can dynamically set this parameter to true.
communication.managerid_
n
Specifies the name of the scheduling manager instance that the agent works with, where
n
is an integer that corresponds to the scheduling manager being configured.
Default:
CENTRAL_MANAGER
Example:
MYSERVER
communication.managerport_
n
Specifies the port that the scheduling manager listens on for communication from agents, where
n
is an integer that corresponds to the scheduling manager being configured. This value corresponds to the port number in the connection details for the scheduling manager.
Default:
7507
Limits:
1024-65534
communication.monitorobject_
n
Specifies the monitor object for the scheduling manager that is used in agent alive ping.
communication.nomanagers.abort.disable
Specifies whether the agent can start with no managers defined in the agentparm.txt file.
  • true
    Indicates that the agent can start with no managers defined.
  • false
    Indicates that the agent cannot start without any managers defined.
Default:
false
communication.protocolrev_n
Specifies the revision of the communications protocol that is negotiated between the manager and the agent. This should not be set or changed except by the manager during communications negotiations.
Default:
2
communication.receiver.socket.aux
Specifies the type of socket the agent uses for its auxiliary port. The value of this parameter must be different from the communication.receiver.socket.main parameter. You can specify the following socket types:
  • plain
  • dylan
Notes:
  • Workload Automation DE does not require this parameter.
  • z/Linux and iSeries systems use plain socket types only.
communication.receiver.socket.main
Specifies the type of socket the agent uses for its main port. The value of this parameter must be different from the communication.receiver.socket.aux parameter. You can specify the following socket types:
  • plain
  • dylan
Default:
plain
Notes:
  • Workload Automation DE does not require this parameter.
  • z/Linux and iSeries systems use plain socket types only.
communication.socket_
n
Defines the socket type the agent and scheduling manager use for communication, where
n
is an integer starting at one that corresponds to the scheduling manager being configured. The following socket types are available:
  • plain
  • dylan
Default:
plain
Note:
z/Linux and iSeries systems use plain socket types only.
communication.transmitter.interface.address
Specifies a local address that the socket is bound to when creating a communication socket.
communication.transmitter.interface.port
Specifies a local range of ports that a socket can be bound to when creating a communication socket.
Example:
2000-2013
communication.v2.nativeafmencoding
Specifies whether an AFM coming from communication protocol revision two is considered to be encoded with native system encoding. Setting this parameter to true lets extended ASCII characters (such as accented characters) to be passed through from the manager to the agent when the manager does not support UTF-8 encoding. All managers that support the v3 protocol support UTF-8 encoding, as well as newer releases of DE that use the v2 protocol (parameter added in 11.3.07).
  • true
    The agent assumes that the AFM is encoded with native system encoding.
  • false
    The agent assumes that the incoming AFM is encoded as UTF-8.
Default:
false
filemon.firstscan.skip
Sets whether the agent skips the first scan of a monitored file. Applies to File Trigger jobs for CREATE, UPDATE, SHRINK, or EXPAND file activity. Also applies to File Watcher jobs when monitoring the existence of a file (not the size).
  • true
    Skips the first scan of the monitored file.
    File Watcher Notes:
    • If the file exists in a stable condition when the job runs, the job does not complete immediately after the first scan. The agent waits for the file to be stable for the complete duration of the watch_interval and then completes.
    • The agent uses the watch_interval as the polling interval for all subsequent scans.
  • false
    Uses the first and subsequent scans for the file system activity monitoring.
    File Watcher Notes:
    • If the file exists in a stable condition when the job runs, the job completes immediately after the first scan.
    • If the agent does not find the file in the first scan, it uses the watch_interval as the polling interval for all subsequent scans.
Default:
false
Note:
On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
filemonplugin.dispatcher.processors
Specifies the maximum number of dispatch processors (threads) used for processing File Trigger jobs. Each new File Trigger job is assigned to an existing dispatch processor (the one with the least number of jobs). If no dispatch processor exists, one is created. When all the existing dispatch processors are at full capacity as specified by filemonplugin.dispatcher.queue_size, a new dispatch processor is created. When the maximum number of dispatch processors is reached, the filemonplugin.dispatcher.queue_size setting is ignored. The job is dispatched to the queue with the least number of requests.
Default:
10
Note:
If a value of -1 is specified, indicating an unlimited number of dispatch processors, the value for filemonplugin.dispatcher.queue_size is ignored. In that case, a dispatch processor is created for each job.
filemonplugin.dispatcher.queue_size
Specifies the maximum queue size for the File Trigger jobs in a dispatch processor. When the maximum is reached, a new dispatch processor is created.
Default:
100
Note:
This value is ignored when the filemonplugin.dispatcher.processors value is set to unlimited (-1).
filemon.state.persistence.enable
Sets whether the agent persists the current state that it maintains while running a File Trigger job. The agent keeps an internal state to prevent sending events about the same file twice.
  • true
    Indicates that the agent persists the current state to disk. When the agent is restarted, the agent restores the current state before scanning for file activity. As a result, the agent does not send out events for files that were processed before the shutdown.
  • false
    Indicates that the agent does not persist the current state. When the agent is restarted, the current state is not restored. As a result, the agent sends out events for some files that were processed before the shutdown.
Default:
false
filemon.update.firstscan.skip
Sets whether the agent skips the first scan of a monitored file for UPDATE activity with no change. Applies to only File Trigger jobs.
  • true
    Skips the first scan on update of the monitored file.
  • false
    Uses the first and subsequent scans for the file system activity monitoring.
Default:
false
Note:
Set this parameter to true to emulate R7 agent behavior.
filemonplugin.runexternal
Enables File Trigger jobs to be run as external processes.
  • true
    File Trigger jobs (which are limited to CREATE) are run as external processes.
  • false
    File Trigger jobs are run as threads under the Workload Automation Agent process.
Default:
false
filemonplugin.strategy
Specifies the sort order that the agent uses to process the files that match the file monitoring criteria. You can specify the following values for the sort order:
  • native_order
    Sorts the files in the native order.
    Note:
    The native order depends on how the files are stored in the directory and how the JRE retrieves them. To preserve the order that the files are created or modified in, we recommend that you use time_asc.
  • alpha_asc
    Sorts the files in ascending alphabetical order.
  • alpha_desc
    Sorts the files in descending alphabetical order.
  • time_asc
    Sorts the files by creation/modification time, with the oldest file processed first (first in, first out).
  • time_desc
    Sorts the files by creation/modification time, with the newest file processed first (last in, first out).
  • size_asc
    Sorts the files by size, with the smallest file processed first.
  • size_desc
    Sorts the files by size, with the largest file processed first.
Default:
alpha_asc
Note:
If you specify an invalid value for the sort order, the default value (alpha_asc) is used.
ftp.anonymous
Specifies whether to allow anonymous login to the FTP server.
  • true
    Allows anonymous login to the FTP server.
  • false
    Does not allow anonymous login to the FTP server.
Default:
false
ftp.ascii.ccsid
Defines the Coded Character Set Identifier (CCSID) to use for ASCII file transfers. If the file being transferred exists on the target computer, the file is written using the encoding of the existing file.
Default:
819
ftp.client.srvtimeout
Enables socket timeout with the specified timeout value in milliseconds. If set to a non-zero timeout, a call to accept() for this ServerSocket will block for only this amount of time.
The FTP service has a socket and a specific port. The client connects to the server on that port. If the connection is successful, the server temporarily gets a new socket for the port so that the server can continue to listen for other connections. After a specified period of time, the server relinquishes the socket.
(A socket is an endpoint in two-way communication between programs on a network. The socket is always bound to a port  so that the TCP layer knows what applications are sending data and where the data is going.)
An error indicates that either the communication was blocked (for example by a firewall) or that the network connection was broken (as a result of an incident such as a network issue, system hang, or a reboot).
Default:
300000 (5 minutes)
ftp.client.ssl
Specifies whether all FTP jobs on the agent computer automatically use SSL communication.
    • true
      Enables SSL communication.
    • false
      Disables SSL communication.
ftp.client.ssl.accept_new_ca
Specifies whether to accept all root certificates and add them to the keystore while verifying the certificates in the chain against the truststore.
  • true
    Accepts all root certificates and adds them to the keystore.
  • false
    Does not accept all root certificates.
Default:
false
ftp.client.ssl.reversechain
Specifies whether the chain of certificates that the peer server provides is processed in reversed order during validation.
  • true
    Processes the chain of certificates for SSL in reversed order.
  • false
    Processes the chain of certificates for SSL in regular order.
Default:
false
ftp.client.ssl.start_with_ssl_session
Specifies whether to start the session to the FTP server securely using SSL.
  • true
    Starts the session to the FTP server using SSL.
  • false
    Does not start the session to the FTP server using SSL.
Default:
false
ftp.client.ssl.truststore
Specifies the full path name of the truststore file. The default file name is cacerts. You can use keytool, provided with the JRE, to create your own truststore.
ftp.client.ssl.truststore.password
Specifies the encrypted password for the client truststore file (for example, cacerts) that contains some common CA X509 certificates.
Default:
changeit (encrypted)
Note:
The password must be encrypted. To encrypt a password, use the Password utility that is provided with the agent.
ftp.client.updatemsg
Specifies how often in milliseconds status information for a running FTP job is updated.
Default:
30000 (30 seconds)
ftp.command.retrydelay
Specifies the time in milliseconds to wait before the retry to send the command.
Default:
1000 (1 second)
ftp.data.compression
Specifies whether to compress data for all FTP jobs on this agent for transfer. The value ranges from zero (0) for no compression to nine (9) for the best compression. If the compression level is also specified in the job definition, the ftp.data.compression value is ignored. The data is compressed using the level that is specified in the job definition. To use FTP data compression, the agent must run both FTP client and FTP server.
Default:
0 (no compression)
ftp.dataports
Specifies a comma separated list of ports that are available for the data channel. Each item in the list can contain a range of ports with a minimum and a maximum port.
Example:
ftp.dataports=4000,9000-9100,9400-9500
ftp.download.owner
Specifies a default user ID on the computer where the agent is installed. This user ID determines the access permissions of a downloaded file on the agent computer. When the file is downloaded, the file is created with this user as the file owner.
Notes:
  • This parameter only applies to agents installed on UNIX systems.
  • A password for the local user ID is not required on the scheduling manager.
ftp.ebcdic.ccsid
Defines the Coded Character Set Identifier (CCSID) to use for EBCDIC file transfers. If the file being transferred exists on the target computer, the file is written using the encoding of the existing file.
Default:
37
ftp.noserver
Specifies whether the agent FTP server is enabled or disabled. If ftp.noserver is set to false, the FTP server is enabled. If the ftp.noserver is set to true, the FTP server is disabled.
Note:
If you enable the FTP plug-in on the agent, ftp.noserver defaults to false. Therefore, if you set plugins.start_internal_
n
=ftp and ftp.noserver is omitted, the agent runs as an FTP server with the default FTP server port of 21.
ftp.passive
Specifies whether the agent FTP client uses a passive mode connection, as follows:
  • true
    Indicates that the agent uses a passive mode connection.
  • false
    Indicates that the agent uses an active mode connection.
Default:
false
Note:
We recommend that you set the value to true under any of the following conditions:
  • The agent uses IPV4 and the FTP server uses IPV6 for communication.
  • The FTP server resides beyond the firewall.
  • The FTP server opens a listening port for the data channel.
ftp.scp.debug.enable
Sets whether debugging of the secure copy protocol (SCP) sessions is enabled. The output is stored in the ftp_scp_debug.log.
  • true
    Enables debugging.
  • false
    Disables debugging.
Default:
false
Note:
This parameter currently only affects SCP/SFTP jobs that are run internally in the System Agent. It does not apply to jobs that are run external to the System Agent (a job defined with RunExternal, run_external, or other method of defining an external job).
ftp.scp.sshd.connect.timeout
Specifies the connection timeout value in milliseconds for SCP/SFTP file transfers.
Default:
30000 (30 seconds)
ftp.scp.sshd.timeout
Controls the read timeout, in milliseconds (ms), for SCP/SFTP jobs.
Default:
30000 (ms)
ftp.server.ssl
Specifies that the FTP server handles both non-SSL and SSL FTP.
ftp.server.ssl.keystore
Specifies the full path of the keystore file. The default file name is serverkeystore. You can use keytool, provided with the JRE, to create your own keystore.
Example:
ftp.server.ssl.keys
ftp.server.ssl.keystore.password
Specifies the encrypted password for the server keystore that contains an X509 certificate. This password is sent to the client during the handshake process.
Default:
cyberuser (encrypted)
ftp.serverport
Specifies the port number for the agent to act as an FTP server.
Default:
21
Limits:
1-65534
ftp.sftp.connect.timeout
Deprecated. Use ftp.scp.sshd.connect.timeout.
ftp.spool.verbose
Specifies whether the agent writes a standard header to the spool file for all FTP jobs.
  • true
    Writes a standard header to the spool file for all FTP jobs.
  • false
    Does not write a standard header to the spool file.
Default:
false
ftp.ssl.protocol
Specifies the authentication protocol that is used for FTP. Supported mechanisms are SSL and TLS.
Default:
TLS
ftp.timeout
Specifies the timeout value for the data socket in milliseconds. This parameter controls the time allowed for reading the data socket. This parameter takes effect as soon as the connection is opened and the server accepts the call, using accept().
If the server is slow, while it is queuing connections for example, it is possible for the client to time out and go away.
Default:
300000 (5 minutes)
i5os.job.cmpc.pattern.maxline
Defines the maximum number of lines that can be used to search for the indexing anchor when CCExit is set to *PATTERN.
Default:
5000
initiators.afmjobclassmap_
n
=
verb
,
subverb
,
jobclass
Maps verb and subverb combinations of a job request to a job class. When the agent sees an AFM containing a defined pair of verb and subverb, it assigns the specified job class to that job.
The defined pair must be a valid verb and subverb combination. Write a separate instance of this parameter for each pair. For some job types, you can also specify a job class in a job definition.
Note:
To find out which verbs and subverbs you can use, see the agent receiver log.
initiators.class_
n
=
jobclass
,
number_of_initiators
Describes job classes and the number of initiators that can process jobs that are assigned a particular job class. Use a new line for each initiators.class_
n
parameter, where
n
is an integer starting at the value 1. By controlling the type and number of initiators, you can have greater control over the initiation of jobs and manually balance the loads on system resources.
The parameter initiators.afmjobclassmap_
n
relates to this parameter. However, the value of
n
does not have to match in both parameters.
For UNIX workload, depending on the number of initiators you assign, you may need to increase the number of threads that can be run per process on your operating system.
Examples:
initiators.class_1=Default,1000
initiators.class_2=POJO,100
initiators.throttle.delay
Specifies the rate in milliseconds (msec) the agent uses to throttle requests. This parameter applies to all classes of initiators. By default, the agent does not throttle requests.
Note:
Using this parameter can slow job throughput.
initiators.throttle_
n=jobclass,throttle_rate
Specifies the rate in milliseconds (msec) the agent uses to throttle requests for a particular job class. By default, the agent does not throttle requests.
Example:
initiators.throttle_1=DEFAULT,250
Note:
Using this parameter can slow job throughput.
installer.version
Specifies the version of the installer used. For informational purposes only. Do not change the value.
log.archive
Defines the log archiving options. Options are as follows:
  • 0
    Appends the current date and time to the log file.
  • 1
    Renames to logfile.archive and starts a new file.
  • 2
    Removes the current file.
  • 3
    Appends new log entries to the current logs.
Default:
0
log.folder
Specifies the directory path where the agent creates the log files.
Default:
agent_install_dir
/log
log.level
Specifies the type and number of logs the agent generates. This parameter is important for troubleshooting. Options are as follows:
  • 0, 1, or 2
    Creates logs for any errors including the receiver and transmitter logs. Level 2 is adequate for production, unless problems arise requiring more details for troubleshooting.
  • 3
    Adds queues. If this value is specified, the agent ignores the log.maxsize parameter.
  • 4 or 5
    Adds debugging information. Use log level 5 for setup and initial testing.
  • 6-8
    Adds tracing information to diagnose a problem. These levels are not intended for continuous use.
Default:
5
log.maxsize=
maximum_size
[
B
|K|M|G]
Specifies the maximum log size. When the log file exceeds the specified size, the agent archives it and starts a new log file. If the log.archive parameter is set to 3, the agent ignores this parameter. The agent does not create an archive file, but it does append all logs. You can specify the following optional modifiers:
  • B
    Specifies the size in bytes.
  • K
    Specifies the size in kilobytes.
  • M
    Specifies the size in megabytes.
  • G
    Specifies the size in gigabytes.
Limits:
Up to 2 GB
Default:
1M
Note:
The default (no modifier) size is in bytes.
management.connector_
n
Identifies the type of management connector the agent uses to connect to an external application, where
n
is an integer starting from 1. You can specify the following types of connectors, which are built into the agent:
    • jmx
      Specifies a JMX connector that lets you use a JMX console to monitor and control the agent.
    • snmp
      Specifies an SNMP connector that lets you use an SNMP manager to monitor and control the agent.
management.jmx.host
Specifies the host name or IP address where the JMX connector listens.
management.jmx.port
Specifies the port where the JMX connector listens.
Default:
1099
Limits:
1-65534
management.jmx.security.password
Specifies the password for the user name that is specified in the management.jmx.security.user parameter.
Note:
The password must be encrypted. To encrypt a password, use the Password utility that is provided with the agent.
management.jmx.security.user
Specifies the user for accessing the JMX console. You can use this parameter together with management.jmx.security.password to ensure that only authorized users can view, monitor, and control the agent using the JMX console.
management.snmp.agent.community.read
Specifies the SNMP read community. This parameter applies only to SNMP v1 and v2.
    • public
      Specifies read-only access.
    • private
      Specifies read/write access.
management.snmp.agent.community.write
Specifies the SNMP write community. This parameter applies only to SNMP v1 and v2.
    • public
      Specifies read-only access.
    • private
      Specifies read/write access.
management.snmp.agent.trapsink.community
Specifies the SNMP community that receives trap information.
  • public
    Specifies read-only access.
  • private
    Specifies read/write access.
Default:
public
management.snmp.agent.trapsink.host
Specifies the host name or the IP address of the SNMP listener that receives trap information. The management connector uses this host to send the trap.
management.snmp.agent.trapsink.port
Specifies the port of the SNMP listener that receives trap information. The management connector uses this port to send the trap.
Default:
162
management.snmp.agent.trapsink.user
Specifies the user authorized to receive trap information.
management.snmp.agent.user
Specifies the user authorized to communicate with the SNMP agent plug-in. This parameter applies only to SNMP v3.
Example:
MBAGENT
management.snmp.agent.user.auth.password
Specifies the encrypted authentication password for the user authorized to communicate with the SNMP agent plug-in. This parameter applies only to SNMP v3.
management.snmp.agent.user.auth.protocol
Specifies the authentication protocol the agent uses. The supported protocols are SHA and MD5. This parameter applies only to SNMP v3.
Example:
SHA
management.snmp.agent.user.priv.password
Specifies the privacy protocol the agent uses. The supported protocols are AES and DES. This parameter applies only to SNMP v3.
Example:
AES
management.snmp.agent.user.priv.protocol
Specifies the privacy protocol the agent uses. The supported protocols are AES and DES. This parameter applies only to SNMP v3.
Example:
AES
management.snmp.agent.version
Specifies the SNMP version of the SNMP manager you want the agent to connect with.
  • 1 -- SNMP v1
  • 2 -- SNMP v2
  • 3 -- SNMP v3
Default:
2
management.snmp.community
Specifies the type of network the SNMP traps are sent across for SNMP v1 or v2 only. Your SNMP administrator can provide the type.
  • public
    Identifies an unsecured network, for example, the Internet.
  • private
    Identifies a secure network, for example, a local area network.
Default:
public
management.snmp.host
Identifies the SNMP Manager IP address or DNS name. Your SNMP administrator can provide the host name.
management.snmp.mibfile
Specifies the path to the MIB file that describes the metrics and SNMP traps for the agent.
Default:
agentinstalldir
/cybermation.mib
management.snmp.port
Specifies the SNMP Manager UDP port. Your SNMP administrator can provide this port number.
Default:
162
Limits:
1-65535
management.wol.nudges
Specifies the number of times the agent broadcasts the magic packet.
Default:
10
management.wol.nudges.sleep
Specifies the amount of time, in milliseconds, between broadcasts of the magic packet.
Default:
1000 (ms)
management.wol.ports
Specifies the port that the magic packet is sent to.
Default:
6
objmon.ipmon.retries
Specifies the number of times the agent attempts (retries) to receive a response from a target machine to determine whether it is running. When the agent runs an IP monitor job, to determine that a machine at an IP address is running, the agent sends a ping request to the target machine and waits to receive a valid reply.
To avoid transient network failures, the agent tries the number of times specified by objmon.ipmon.retries. The agent returns only after it has retried the specified number of times. For each loop (or try), the timeout value is 5 seconds. The agent will retry for the full retries count.
For example, after sending the ping, the agent waits 5 seconds. If it does not receive a response from the target machine, it tries 3 more times, waiting 5 seconds in between each try. If no response is received, the agent determines that the machine is down.
Adjust this setting based on the nature of your environment. If the possibility of transient network failures is small, or the false returns indicating that a machine is down is not an issue, you can set this value to a lower number to return the status of the machine more quickly. If you receive many returns falsely indicating that the machine is down, set the value higher to give the agent more time to correctly determine that a machine is running.
Default:
4
os400.add.threads
(iSeries only) Sets the number of threads available to add jobs to the job queue. The agent will start one job per thread when they arrive. If a number of jobs arrive at exactly the same time, this parameter can be modified to make sure they all get added to the list without excessive latency.
Default:
1
os400.job.monitor.interval
(iSeries only) Sets the sleep time in milliseconds between status checks on jobs running on the iSeries processor. The agent sends a new status message to the scheduler every time it wakes up This parameter can be modified to manage the performance of the QZRCSRVS prestart job.
Default:
10
os400.product.library
(iSeries only) Specifies the library in which the native iSeries objects are installed.
Default:
CAWAGNT113
os400.quote.parameter
(iSeries only) Sets whether the agent encloses every parameter of the CL program in single quotes. This parameter can be useful for customers migrating from the Universal Job Management Agent (UJMA).
  • true
    Encloses every parameter of the CL program that is passed to the agent in single quotes.
  • false
    Does not enclose parameters of the CL program in single quotes. The parameters are passed as is.
Default:
false
Notes:
When migrating to the agent from CA UJMA, update your UJMA job definitions as follows:
  • *BLANK is a UJMA term, which is not a valid keyword for the agent. Therefore, *BLANK must be converted into ' ' (two single quotes that are separated by a space).
  • *EMPTY is a UJMA term, which must be converted into '' (two single quotes that are concatenated together). If *EMPTY ('') is the last argument, os400.quote.parameter must be set to false.
  • If a parameter contains a space, enclose the parameter in single quotes: 'this parameter has a space.'
os400.receiver.threads
(iSeries only) Sets the number of threads that can be used to process jobs running on the iSeries processor. The agent can process one job at a time on each receiver thread. If a large number of jobs are being processed at the same time, this parameter can be modified to allow them to process in parallel, reducing latency and queue management overhead.
Default:
1
os400.run.job.ccsid
(iSeries only) Specifies the default Coded Character Set Identifier (CCSID) to use for iSeries jobs. IBM publishes and maintains the CCSIDs. CCSIDs are always integers. In a job definition, you can override the default value by specifying the CCSID as a parameter that gets passed to the iSeries SBMJOB command.
Note:
If you do not specify the CCSID in either this parameter or the job definition, the system default on iSeries is used.
oscomponent.agentparm.backupfilelimit
Specifies a limit for the number of agentparm.txt backup files created by the agent. When the specified limit is reached, the number of backup files that exceed the limit are deleted, starting with the oldest. If you do not set this parameter, the agent retains its current behavior and saves all backup copies. The agent logs all activity related to this parameter in the default_agent.log file.
You must set the value of this parameter to 1 or greater, otherwise no backup copies are deleted.
oscomponent.auth.pam.lib
(UNIX only) Specifies the path to the PAM shared library.
Note:
We recommend that you specify the full path to the library file.
oscomponent.auth.pam.svc
(UNIX only) Specifies the default PAM service the agent uses for login authentication. The list of available PAM services for your system is located in the /etc/pam.conf or /etc/pam.d/ file.
Default:
login
Note:
You can use the chkusr utility that the agent provides to test a PAM service being used to authenticate a user and password.
oscomponent.checkvalidshell
(UNIX only) Determines whether the agent checks valid shells.
  • true
    Indicates that the agent checks valid shells. All shells that jobs use must be specified in the oscomponent.validshell parameter.
  • false
    Indicates that the agent bypasses the valid shell check.
Default:
true
oscomponent.classpath
Specifies the path to the JAR files that the agent requires.
oscomponent.cmdprefix.force
(UNIX) Specifies whether the agent submits the command using a temporary wrapper shell script.
(Windows) Specifies whether the agent submits the command using the Windows command interpreter (cmd.exe).
  • true
    (UNIX) Indicates that the agent submits the command using a temporary wrapper shell script that the agent generates.
    (Windows) Indicates that the agent submits the command using cmd.exe. The command is prefixed with "cmd /c" to allow built-in commands such as dir and echo to execute properly.
    Note:
    Commands that contain embedded blanks in their path (for example, c:\temp\tst one\test.cmd) fail unless oscomponent.cmdprefix.force.quotes.full is also set to true.
  • false
    (UNIX) Indicates that the agent submits the command by itself without generating the temporary wrapper shell script. When set to false, a wrapper shell can still be created unless oscomponent.profiles.src.delay=false and oscomponent.lookupcommand=false.
    (Windows) Indicates that the agent submits the command by itself without using cmd.exe.
Default:
false
Note:
On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
oscomponent.cmdprefix.force.quotes.full
(Windows only) Specifies whether the agent wraps the entire command in double quotes before the Windows command interpreter (cmd.exe) runs the command. This parameter is applicable if oscomponent.cmdprefix.force is set to true.
true
Indicates that the agent wraps the entire command in double quotes before cmd.exe runs the command. Set this parameter to true to allow a command that has spaces and special characters (such as, &()[];,!^%) in its path to run without error, for example:
"C:\ Program Files (x86)\command.bat" "C:\ Program Files (x86)\input-file"
Notes:
  • Commands that contain contain spaces or special characters in their paths succeed, for example: C:\Program Files\program.exe.
  • Commands that contain an argument in quotes succeed, for example: Command=%TEMP%\bin\test.bat, Args=\“Test Message”
    This job succeeds because the final executable string is: cmd.exe /c ““%TEMP%\bin\test.bat” “Test Message””
  • Commands with arguments that do not contain a quote succeed, for example: Command=%TEMP%\bin\sleep.exe, Args=5
    This job succeeds because the final executable string is: cmd.exe /c “%TEMP%\bin\sleep.exe” 5”
  • Commands with arguments fail if the entire command, including arguments, is quoted, for example: "C:\tools\program.exe arg1 arg2".
false
Indicates that the agent does not wrap the entire command in double quotes before cmd.exe runs the command.
Notes:
  • Commands that contain spaces or special characters in their paths fail, for example: C:\Program Files\program.exe.
  • Commands with arguments that contain a quote fail, for example: Command=%TEMP%\bin\test.bat, Args=\“Test Message\”
    This job fails because the final executable string is: cmd.exe /c “%TEMP%\bin\test.bat” “Test Message”
  • Command with arguments that do not contain a quote succeed, for example: Command=%TEMP%\bin\sleep.exe, Args=5
    This job succeeds because the final executable string is: cmd.exe /c “%TEMP%\bin\sleep.exe” 5
  • Commands with arguments succeed if the entire command, including arguments, is quoted and the path does not contain embedded spaces, for example: "C:\tools\program.exe arg1 arg2".
Default:
false
Note:
On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
oscomponent.cmdprefix.force.redir.ifstdon
(Windows only) Sets whether to prevent the agent from redirecting STDOUT/STDERR if none are specified in the job definition.
  • true
    Prevents the agent from redirecting STDOUT/STDERR if none are specified in the job definition. If the output of the command requires user input, such as pause, it is displayed in the cmd.exe console window.
  • false
    Does not prevent the agent from redirecting STDOUT/STDERR if none are specified in the job definition.
Default:
false
Note:
This parameter requires oscomponent.cmdprefix.force=true and the Windows job has to be interactive.
oscomponent.cmdprefix.force.redir.inline
(Windows only) Sets whether the agent forces inline redirection. In some cases, such as Windows Server 2008 R2, inline redirection is required for the console to be displayed in Session 0.
  • true
    Forces inline redirection using cmd.exe /c
    command
    args
    stdin_file
    >
    stdout_file
    >
    stderr_file
    .
  • false
    Does not force inline redirection.
Default:
false
Note:
This parameter requires oscomponent.cmdprefix.force=true and affects FTP verbose mode. If regular redirection is used, the commandftp - s:command_file will not output raw FTP commands with completion codes as per FTP protocol.
oscomponent.default.password
Specifies the password for the default user ID.
Note:
This parameter is only required for Windows systems.
oscomponent.default.user
Specifies the default operating system user name.
Note:
The user that is specified in a job definition overrides this value.
oscomponent.defaultfile.permission
(UNIX only) Specifies the standard UNIX file permission in octal notation starting with 0. The four-digit octal code specifies the default file access permissions for the following files that the agent creates:
  • Temporary working shell scripts (Workload Automation AE only)
  • Standard output and standard error files
  • Job logs
  • Spool files
Example:
0600 (grants read and write permissions to the owner, but prevents anybody else from accessing the file)
This parameter works in conjunction with the oscomponent.umask parameter, which turns off (disables) specific permissions that the oscomponent.defaultfile.permission parameter allows.
Notes:
  • If oscomponent.defaultfile.permission is not specified, all files the agent creates will have the same permissions as before 11.3 SP1 cumulative 4.
  • Temporary working shell scripts are granted execute permissions by the agent regardless of this parameter.
  • This parameter does not change the access permission of the spool directory (that is, drwxrwxrwt).
oscomponent.defaultshell
(UNIX only) Identifies the shell in which scripts are run on the system.
Default:
/bin/sh
oscomponent.defaultshell.force
(UNIX only) Indicates whether to force the agent to use the default shell that is specified in the oscomponent.defaultshell parameter.
  • true
    Forces the agent to use the default shell to run UNIX scripts and to source the user profile.
  • false
    Does not force the agent to use the default shell.
Default:
false
oscomponent.environment.variable
Specifies the path to the file that defines agent-wide variables.
Example:
C:\MyVars\agent_vars.txt
oscomponent.environment.variable_manager_
manager_id
Specifies the path to the file that defines manager-specific variables.
  • manager_id
    Specifies the name of the specific scheduling manager the environment variables apply to.
Example:
C:\MyVars\mgr_stress_vars.txt
oscomponent.environment.variable_user_
user_id
Specifies the path to the file that defines user-specific variables.
  • user_id
    Specifies the name of the user the environment variables apply to.
Example:
C:\MyVars\usr_abc.txt
oscomponent.initialworkingdirectory
Specifies the default initial working directory for all scripts. Options are as follows:
  • SCRIPT
    Sets the path to where the script resides.
  • USER
    Sets the path to the home directory of the owner of the script.
  • USER_CONT_NOT_AVAIL
    Specifies that the script should run even if a home directory for the user is not defined.
  • path
    Specifies the path to the directory in which the script should run.
Notes:
  • On Workload Automation AE, set this parameter to USER_CONT_NOT_AVAIL for backward compatibility with legacy agents.
  • If you do not specify a value, the parameter defaults to the path where the running cybAgent resides.
  • You can override the initial working directory on a per-job basis by specifying a value for the PWD or HOME environment variable.
  • If the specified directory either does not exist or cannot be accessed, jobs can fail:
    • While trying to create or access the file, if there is an stdout, stderr, or stdin file specified using a relative path (which should make it look in the initial working directory)
    • When trying to set the initial working directory (the equivalent of typing “cd newdirectory” at a command prompt) before executing the job’s command
oscomponent.interactive
(Windows only) Indicates whether the agent submits Windows jobs in interactive mode instead of batch mode.
  • true
    Submits Windows jobs in interactive mode. Interactive mode lets users view and interact with jobs that invoke Windows Terminal Services or user interface processes, for example, Notepad.
  • false
    Submits Windows jobs in batch mode.
Default:
false
oscomponent.killsignals
Specifies a list of signals to be sent to the process for a job. If the process does not go away after sending the first signal in the list, the agent sends the next signal. (If you do not specify a list of signals for this parameter, the agent defaults to the current behavior of using SIGKILL.)
Example:
oscomponent.killsignals=2,10,9
Default:
9
If you do not set this parameter, the current behavior is maintained; the agent sends a SIGKILL by default.
oscomponent.killsignals.interval
Specifies the time in seconds after a signal is sent that the agent waits for the process to go away before sending the next signal. (If you do not specify a value for this parameter, the agent defaults to an interval of 5 seconds.)
Example:
oscomponent.killsignals.interval=7
Default:
5
oscomponent.interactive.session.ignoreinactive
(Windows only) Sets whether the agent reuses an inactive terminal session.
  • true
    Reuses an inactive terminal session.
  • false
    Ignores an inactive terminal session. If the session is disconnected remotely, the interactive job fails.
Default:
false
oscomponent.interactive.sessionzero
(Windows only) Sets whether the agent runs the interactive job in Session 0.
  • true
    Runs all interactive jobs using Session 0. The user is not required to log in to the agent computer before the job runs. A greater amount of resources is available to run the job.
  • false
    Runs all interactive jobs using Terminal Services.
Default:
false
oscomponent.javapath
Specifies the full path to the directory where Java resides.
oscomponent.joblog
Sets whether the agent creates a job log for each job that runs.
  • true
    Enables job logs.
  • false
    Disables job logs.
Default:
true
oscomponent.joblog.success.autocleanup
Indicates whether to delete the job log automatically when the job completes successfully.
  • true
    Deletes the job log automatically when the job completes successfully.
  • false
    Does not delete the job log automatically when the job completes successfully.
Default:
false
oscomponent.jvm.x.options
Specifies the virtual memory heap size.
oscomponent.loginshell
(UNIX only) Indicates how to invoke the Shell program when executing a script.
  • true
    Invokes the shell as a login shell. The shell program looks in the directory that the HOME environment variable specifies and tries to execute the login scripts of the user (in addition to the .cshrc script).
  • false
    Ignores the shell as a login shell.
Default:
false
Note:
For most systems, this parameter affects only the C and Korn shells. The Bourne shell ignores the oscomponent.loginshell parameter.
oscomponent.logon.batch.first
(Windows only) This parameter specifies the order of the logon attempts. When set to true, the logon attempt order is changed from ‘interative first, batch second’ to ‘batch first, interactive second.’
RUN jobs that target an agent running on Windows can specify that the jobs run as a specific user. When the agent logs in as the specified user, it logs in as either an Interactive or a Batch session. By default the agent first tries to log on as Interactive; if that fails, it then tries to log on as Batch.
In some cases (typically for security reasons), a user is prevented from logging in as Interactive. If the batch logon succeed, the job runs successfully. However, this approach can be inefficient. The failed logon attempt slows the job’s execution and results in extra logging in the agent. This extra logging can appear to be Java exception failures.
For situations where it is understood that batch logons will be used, you can reverse the logon attempt order. Set this parameter to true to change the order from ‘interative first, batch second’ to ‘batch first, interactive second.’
Example:
oscomponent.logon.batch.first=true
oscomponent.logon.elevated
(Windows only) Indicates whether the agent submits jobs in elevated mode on Windows.
  • true
    Submits the job in elevated mode on Windows.
  • false
    Does not submit the job in elevated mode on Windows.
Default:
false
oscomponent.lookupcommand
Determines how to specify the script or command name (UNIX) or command file (Windows) to run in a job definition.
  • true
    Indicates that the script, command name, or command file can be specified without the full path in a job definition. On UNIX, the agent looks up the path to the script or command name for the specified user ID. On Windows, the agent looks up the path to the command file in the following directories, in the order listed:
    • agent installation directory
    • WINDOWS\system32 directory on 32-bit versions of Windows (or WINDOWS\SysWow64 directory on 64-bit versions of Windows)
    • WINDOWS\system directory
    • WINDOWS directory
    • system path
    • user path
  • false
    Indicates that the full path to the script, command name, or command file must be specified in the job definition.
Default:
true
Notes:
  • On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
  • If set to true, verify that the agent on UNIX is running under the root account.
  • The agent does not resolve environment variables that are specified in the command file path for Windows jobs.
oscomponent.lookuposerror
Enables operating system errors to pass from the agent to the scheduling manager.
  • true
    Enables the operating system errors.
  • false
    Disables the operating system errors.
Default:
false
oscomponent.noexitcode
Specifies the exit code that tells the agent not to send a completion code to the scheduling manager host. Valid values depend on what return codes are allowed by the application, the shell, and the operating system. For example, on Linux, shell scripts can only return values between 0 and 255.
Default:
255 for UNIX, 127 for Windows
Note:
On Workload Automation AE, set this parameter to 256 for backward compatibility with legacy agents.
oscomponent.noforceprofile
(UNIX only) Specifies whether the agent allows loading a .profile/.login file that is based on the usual UNIX rules for sourcing .profile/.login.
  • true
    Prevents the agent from loading the .profile/.login file.
  • false
    Allows the agent to load the .profile file.
Default:
false
Notes:
  • On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
  • If oscomponent.loginshell is set to false and a user is not specified in the job definition, no .profile/.login is sourced and oscomponent.noforceprofile is ignored.
oscomponent.pamlogin.enable
Specifies that the agent use PAM to log a user in. (Parameter added in 11.3.07.)
  • true
    The agent uses PAM to log the user in.
  • false
    The agent does not use PAM to log the user in.
Default:
false
oscomponent.pamlogin.svc
When set, this parameter specifies the PAM service to use to log a user in. The value can be su, login, sshd, sudo, or any other PAM service installed on the system that supports password authentication.
For example, if PAM login is enabled and "oscomponent.pamlogin.svc=su" on Linux, and "pam_limits.so" is specified for the session module interface in the PAM configuration file for the su service, when the user session is created, it loads the user-specific ulimit values from the limits.conf file and applies them to the session.
If the System Agent is run as the root user, typically no password is required for a user to log in as another user when using the su service. This allows administrators the benefit of using PAM session initialization (such as "pam_limits.so"), without having to change the job definition to send a password for the user.
If oscomponent.pamlogin.svc is set to login, sshd, or any other PAM service, a password is required. This behavior is similar to the behavior on Windows, where a password is always required. (Parameter added in 11.3.07.)
For more information about how to configure PAM, see the documentation for PAM on your system.
oscomponent.profiles.global.override
Specifies whether or not the agent sources an available job profile or the profile specified by the EWAGLOBALPROFILE environment variable.
  • true
    If the job profile is present, the agent sources the job profile. The agent does not source the profile specified by EWAGLOBALPROFILE (/etc/auto.profile).
  • false
    If the job profile is not present, the agent sources EWAGLOBALPROFILE.
Default:
false
oscomponent.profiles.src.delay
(UNIX only) Specifies whether the agent executes the sourcing of profiles (global and job) from a temporary shell script.
  • true
    Indicates that the agent executes the sourcing of profiles from a temporary shell script that the agent generates. The agent does not add /etc/profile or the login profile of the user to this temporary shell script. To further control which profile (global or job) gets sourced as part of execution, use the oscomponent.profiles.global.override parameter.
  • false
    Indicates that the agent does not execute the sourcing of profiles from a temporary shell script.
Default:
false
Note:
On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
oscomponent.profiles.src.location.iwd
(UNIX only) Specifies whether the initial working directory is used to source the specified profile when it does not contain a full path.
  • true
    Indicates that the initial working directory is used to source the specified profile when it does not contain a full path.
    Note:
    If the profile is located in a subdirectory under the initial working directory, specify the profile using a relative path:
    subdirectory
    /my_profile or ./
    subdirectory
    /my_profile.
  • false
    Indicates that the
    installDir
    /profiles directory is used to source the specified profile when it does not contain a full path.
Default:
false
Note:
If the profile path starts with a /, it is considered a full path, for example: /
subdirectory
/my_profile. In this case, the oscomponent.profiles.src.location.iwd setting is ignored.
oscomponent.profiles.src.order.global.first
(UNIX only) Indicates whether EWAGLOBALPROFILE (/etc/auto.profile) is sourced before or after the job profiles.
  • true
    Indicates that EWAGLOBALPROFILE is sourced first before the job profile.
  • false
    Indicates that EWAGLOBALPROFILE is sourced last after the job profile.
Default:
false
Note:
On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
oscomponent.profiles.src.verify
(UNIX only) Specifies whether the agent verifies that the job profile that is specified in the job definition exists before the job runs. This parameter is applicable if oscomponent.profiles.src.delay is set to true.
  • true
    Indicates that the agent verifies that the job profile that is specified in the job definition exists before the job runs. If the specified job profile does not exist, the job returns a submission error indicating the reason for the error.
  • false
    Indicates that the agent does not verify that the job profile that is specified in the job definition exists before the job runs. If the specified job profile does not exist, the job fails without an appropriate error message.
Default:
false
Note:
On Workload Automation AE, set this parameter to true for backward compatibility with legacy agents.
oscomponent.restoredrives
When set to true, this parameter restores mapped drive letters when jobs are run as external OS users. When jobs run as external OS users, the agent can restore the mapped drive letters defined by the external user prior to executing the job. With the mapped drives restored, jobs can reference external files by drive letters rather than the UNC style file names.
This setting is global to the agent. Because it takes time for the agent to restore the drive letters before executing the job, the preferred method for referencing external files is through UNC style file names.
oscomponent.sendsig.term.group
(UNIX only) Indicates whether the SIGTERM and SIGKILL signals are always sent to the entire process group.
  • true
    Indicates that the SIGTERM and SIGKILL signals are always sent to the entire process group. The signal is sent to the entire group whether the signal number is positive or negative.
  • false
    Indicates that the SIGTERM and SIGKILL signals are not always sent to the entire process group.
    Note:
    On Workload Automation AE, this setting ensures full compatibility with the legacy agent and maintains the correct behavior of the sendevent command.
Default:
false
oscomponent.servicedisplayname
(Windows only) Specifies the name of the Windows service for the agent. You can control the agent on Windows as a service.
Default:
Workload Automation Agent 11.3
oscomponent.servicename
(Windows only) Specifies the agent name as it appears in the list of services. The length of the service display name must fall within Windows guidelines. Use a unique name if you install more than one agent.
Default:
Workload Automation Agent 11.3
oscomponent.shell
(Windows only) Specifies the executable file name for an alternative Windows shell.
Default:
explorer.exe
oscomponent.su.newconsole
(Windows only) Sets whether to force the agent to create a console when running a Windows job.
  • true
    Creates a console when running a Windows job.
  • false
    Does not create a console when running a Windows job.
Default:
false
oscomponent.terminate.subtree
(UNIX only) Specifies whether the agent kills the process group or manually kills each process in the process subtree when a UNIX job is canceled.
  • true
    Indicates that the agent assembles the process subtree and manually kills each process. This approach ensures that all processes associated with the UNIX job are terminated.
  • false
    Indicates that the agent sends the kill signal to the script's process group ID . As a result, the kill signal is delivered individually to all processes that are members of the group. Any process that is not a member of the group does not get terminated.
Default:
false
Note:
If oscomponent.terminate.subtree is set to true, the agent sends the SIGKILL signal to cause the process to terminate immediately. The agent does not provide the option to send the SIGTERM signal, so the receiving process cannot perform any clean-up upon receiving the signal. The default behavior (oscomponent.terminate.subtree=false) does provide an option to send the SIGTERM signal.
oscomponent.terminate.wait
(Unix only) Indicates that when a CONTROL CANCEL for a job is received, the agent should first attempt to kill the job’s process with SIGTERM (signal 15), then wait the number of seconds set in the parameter. If the process is still running after that time has elapsed, the agent sends the default SIGKILL (signal 9) to kill the process. This parameter can be set to any integer value.
Default:
none
The setting for oscomponent.killsignals overrides the setting for oscomponent.terminate.wait. When oscomponent.killsignals is set, only the signals in oscomponent.killsignals are sent.
oscomponent.umask
(UNIX only) Provides support for the umask command, which turns off (disables) specific permissions that the oscomponent.defaultfile.permission parameter allows. The three-digit octal code sets the file mode creation mask (umask) for the following files that the agent creates:
  • Temporary working shell scripts (Workload Automation AE only)
  • Standard output and standard error files
  • Job logs
  • Spool files
Example:
066 (assuming the default file access permission is 666, this value turns off read and write permissions for the group and others)
Notes:
  • If oscomponent.umask is not specified, the default umask of the user that started the agent is used for job logs, spool files, and wrapping scripts.
  • For standard output and error files, the default umask of the user that runs the job is used with an exception on AIX and HP-UX. On AIX and HP-UX, the default umask is only used if the umask is set in the user profile.
oscomponent.validshell
(UNIX only) Identifies the full path and name of every shell that is valid for use on the agent. Separate each shell with a comma.
Default:
/usr/bin/sh,/bin/csh,/bin/ksh,/bin/sh,/bin/bash
Note:
This parameter is verified when the oscomponent.checkvalidshell parameter is set to true (the default). If the shell used in a job definition or script is not specified in this parameter, the job fails.
oscomponent.wrapper.exec.force
Specifies whether the wrapper script the agent generates puts exec in front of the target script or binary. This parameter is applicable if oscomponent.cmdprefix.force is set to true.
  • true
    Indicates that the wrapper script the agent generates puts exec in front of the target script or binary.
  • false
    Indicates that the wrapper script the agent generates does not put exec in front of the target script or binary. Set this parameter to false to enable chained commands, for example, /bin/sleep 10; echo hello.
    Note:
    If this parameter is set to false, you cannot send a signal to the job unless you set oscomponent.sendsig.term.group to send the signal to the entire process group.
Default:
false
persistence.dbfolder
Specifies the name of a directory where persistence files are stored. When the agent is restarted, these files are used to track outstanding jobs.
Default:
database
persistence.level
Specifies the persistence level. Options are as follows:
  • 0
    Indicates no persistence; maximum speed.
  • 1
    Indicates that most queues and registration maps are persistent, so there is some recovery ability.
  • 2
    Indicates the maximum persistence level.
Default:
2
plugins.object.storage.persistasplaintext
Specifies whether to persist the Java serialized object of a payload producing job in text format in addition to the binary output.
  • true
    Persists the Java serialized object of a payload producing job in text format. The agent converts the Java object to text and outputs it to a text file in the same location as the binary file. The output file of the plain text version has the same name as the binary file, except with a .txt extension.
    This global setting applies to all payload producing jobs. Depending on the number of payload producing jobs, this setting can cause an excess number of files to be created. Alternatively, when supported on the scheduling manager, you can enable this setting at the job-level for specific jobs.
    SNMP jobs return an array as the Java object. If the array contains only one element, the agent removes the extraneous Java array from the element before converting it to text format. If the array contains more than one element, the agent outputs the entire array in text format. Most SNMP jobs return only one item in the array.
  • false
    Does not persist the Java serialized object of a payload producing job in text format.
Default:
false
Currently, you cannot retrieve the text or binary format of Java serialized objects from the scheduling manager.
plugins.start_internal_
n
Specifies the agent plug-in to start by the core Java agent.
  • n
    Denotes an integer that is assigned to the agent plug-in, starting at 1. The
    n
    suffix must increase sequentially for each agent plug-in.
runnerplugin.spool.clean.enable
Specifies whether the agent deletes spool files.
  • true
    Enables the spool file cleaner.
  • false
    Disables the spool file cleaner.
Default:
false
Note:
If enabled, the agent deletes spool files older than 10 days (7 days for Workload Automation AE) and checks the spool files every day. To specify a different file expiration value, set the runnerplugin.spool.expire parameter. To specify a different sleep interval value, set the runnerplugin.spool.sleep parameter.
runnerplugin.spool.expire
Specifies the file expiration time. The agent deletes spool files that are older than this value. This parameter uses the following syntax:
n
[D|H|M|S]
  • n
    Specifies the time period.
  • D
    Specifies the time period unit as days. This is the default.
  • H
    Specifies the time period unit as hours.
  • M
    Specifies the time period unit as minutes.
  • S
    Specifies the time period unit as seconds.
Default:
10D (10 days)
Note:
You cannot specify combinations of time periods. For example, 12D3H is not valid.
runnerplugin.spool.sleep
Specifies the sleep interval. At every interval, the agent checks for spool files that meet the expiration time and deletes them.
Default:
1D (1 day)
security.cryptkey
Specifies the path to the text file that stores the encryption key for the agent.
Default:
  • For UNIX:
    /CA/WA_Agent_R11_3/cryptkey.txt
  • For Windows:
    C:\Program Files\CA\WA Agent R11.3\cryptkey.txt
  • For iSeries
    /CA/WA_Agent_R11_3/cyrptkey.txt
security.filename
Specifies the path to the security file that contains the security rules that define local security on the agent.
Default:
agentinstallDir
/security.txt
security.level
Specifies whether local security on the agent is enabled or disabled. Local security on the agent controls which scheduling manager user IDs can perform certain actions, for example, which user IDs can issue CONTROL messages to the agent. If you enable local security, define security rules in a security.txt file.
security.ssh.ciphers
Specifies the list of ciphers to be used by the agent for SSH communications. Separate the ciphers in the list with a comma. The first cipher in the list is the preferred cipher.
Values:
3des-cbc
3des-ctr
blowfish-cbc
blowfish-ctr
twofish128-cbc
twofish128-ctr
twofish192-cbc
twofish192-ctr
twofish-cbc
twofish256-cbc
twofish256-ctr
aes128-cbc
aes128-ctr*
aes192-cbc
aes192-ctr
aes256-cbc
aes256-ctr
serpent128-cbc
serpent128-ctr
serpent192-cbc
serpent192-ctr
serpent256-cbc
serpent256-ctr
idea-cbc
idea-ctr
cast128-cbc
cast128-ctr
arcfour
arcfour128
arcfour256
Example:
aes128-ctr,aes192-ctr
security.ssh.macs
Specifies the list of MACs to be used by the agent for SSH communications. Separate the MACs in the list with a comma. The first MAC in the list is the preferred MAC.
Values:
hmac-sha1
hmac-sha1-96
hmac-md5
hmac-md5-96
hmac-sha2-256
hmac-sha2-256-96
hmac-sha2-512
hmac-sha2-512-96
Example:
hmac-md5,hmac-sha1
snmp.request.retries
Defines the maximum number of times the agent requests SNMP trap information. Zero indicates one attempt.
Default:
0
snmp.request.retries
Defines the maximum number of times the agent requests SNMP trap information. Zero indicates one attempt.
Default:
0
snmp.request.timeout
Defines the time-out, in milliseconds (ms), when the agent requests SNMP trap information.
Default:
2000 (ms)
snmp.response.translate
Sets whether the agent translates Object Identifiers (OIDs).
  • true
    Enables translation.
  • false
    Disables translation.
Default:
false
snmp.response.translate.full
Sets whether the agent translates the Object Identifiers (OIDs) from the numeric format to the string format.
  • true
    Enables full-name translation.
  • false
    Disables full-name translation.
Default:
false
snmp.trap.listener.community
Specifies the v1 or v2 SNMP trap community. The SNMP trap listener ignores traps that do not match this community type.
Default:
public
snmp.trap.listener.host
Specifies the IP address of the agent listening for trap information.
snmp.trap.listener.port
Specifies the agent port listening for trap information.
Default:
162
Limits:
1-65535
snmp.trap.listener.version
Specifies the SNMP version of the SNMP manager you want the agent to connect with.
  • 1 -- SNMP v1
  • 2 -- SNMP v2
  • 3 -- SNMP v3
Default:
2
snmp.trap.listener.v3.auth.password_
n
Specifies the encrypted authentication password for the SNMP v3 user, where
n
is an integer starting from 1. All parameters ending with the same value of
n
belong to the same group. This parameter applies only to SNMP v3.
snmp.trap.listener.v3.auth.protocol_
n
Specifies the authentication protocol of the SNMP trap listener, where
n
is an integer starting from 1. All parameters ending with the same value of
n
belong to the same group. This parameter applies only to SNMP v3.
    • MD5 -- Message Digest 5 Algorithm
    • SHA -- Secure Hash Algorithm
snmp.trap.listener.v3.engine_
n
Specifies the agent engine ID that sends trap information, where
n
is an integer starting from 1. All parameters ending with the same value of n belong to the same group. This parameter applies only to SNMP v3.
Default:
AGENT_ENGINE
snmp.trap.listener.v3.priv.password_
n
Specifies the encrypted privacy password for the SNMP v3 user, where
n
is an integer starting from 1. All parameters ending with the same value of
n
belong to the same group. This parameter applies only to SNMP v3.
snmp.trap.listener.v3.priv.protocol_
n
Specifies the privacy protocol for the SNMP v3 user, where
n
is an integer starting from 1. All parameters ending with the same value of
n
belong to the same group. This parameter applies only to SNMP v3. Options are as follows.
    • AES
      Specifies the Advanced Encryption Standard that uses a 32-character encryption key. AES is the algorithm that U.S. Government organizations require to protect sensitive (unclassified) information (FIPS-140-2 compliance).
    • DES
      Specifies the Data Encryption Standard that uses a 16-character encryption key.
snmp.trap.listener.v3.user_
n
Specifies the user authorized to communicate with the SNMP v3 agent, where
n
is an integer starting from 1. All parameters ending with the same value of
n
belong to the same group. This parameter applies only to SNMP v3.
spooldir
This required parameter specifies the path to the spool file directory. It is set only during the install.
Default:
spool subdirectory of the agent installation directory.
tcpip.authentication.protocol
Specifies the authentication protocol for SSL.
Default:
TLS
tcpip.keystore.password
Specifies the encrypted keystore password for SSL support
tcpip.ssl.allowSelfSigned
Specifies whether self-signed SSL certificates are allowed.
  • true
    Allows self-signed SSL certificates. Self-signed certificates let you create certificates for free, without having to pay a Certificate Authority (CA) or comply with any auditing requirements.
  • false
    Does not allow self-signed SSL certificates.
Default:
false
tcpip.ssl.keymanager.algorithm
Specifies the key manager algorithm for SSL.
Default:
SunX509
tcpip.ssl.keystore
Specifies the name of a keystore file for SSL. A keystore is a repository of certificates that are used for identifying a client or a server. You can generate your own keystore using the keytool utility that is provided with the JRE.
Default:
tlskeys.txt
tcpip.ssl.reversechain
Specifies whether the chain of certificates for SSL is processed in reversed order.
  • true
    Processes the chain of certificates for SSL in reversed order.
  • false
    Process the chain of certificates for SSL in regular order.
Default:
false
tcpip.ssl.useacl
Specifies whether ACL is used as the authentication protocol for SSL.
  • true
    Uses ACL as the authentication protocol for SSL.
  • false
    Does not use ACL as the authentication protocol for SSL.
Default:
false
tcpip.truststore.password
Specifies the encrypted truststore password for SSL support.