Troubleshooting › Agent Parameters used for Troubleshooting

Agent Parameters used for Troubleshooting

You can add the following parameters to the agentparm.txt file, as required, to configure the agent. These parameters are generally used for troubleshooting.

communication.timeout

Specifies the time, in milliseconds (ms), for TCP/IP that can elapse between a message being sent and an acknowledgement (ACK) being received. If this time is exceeded, the connection will be aborted.

Default: 10,000 milliseconds (10 seconds)

core.health.monitor.interval

Specifies the polling interval, in milliseconds (ms), for logging the resource usage information within the Java Virtual Machine.You can set this parameter when the core.health.monitor.enable parameter is set to true.

Default: 60,000 (1 min)

Note: The minimum interval time is 1000 ms (1 sec). If the specified interval is less than the minimum, the agent ignores that value and logs the information at every 1000 ms.

filemonplugin.sleepperiod

Specifies the time, in milliseconds (ms), a Monitoring job uses as the polling interval for file monitoring. Specify no less than 1000 ms.

Default: 30,000 (30 sec)

Note: This parameter does not apply to CA Workload Automation AE.

ftp.client.separator

Specifies the character that will be used to separate multiple file entries in the LOCALFILENAME or REMOTEFILENAME statements.

ftp.ssl.provider=IbmX509

Specifies an AIX parameter that supports IBM JSSE (Java Secure Socket Extension), a Java implementation of SSL and TLS.

Note: Do not change the value.

ftp.userfile=path

Specifies the location of the FTP user ID and password file. The default file name is ftpusers.txt.

Example: /export/home/userid/WA Agent R11.3/ftpusers.txt

log.archive

Defines the log archiving options:

• 0—Appends current date and time to the log file.
• 1—Renames to logfile.archive and starts a new file.
• 2—Removes current file.
• 3—Appends new log entries to the current logs.

Default: 0

log.folder

Specifies the location of the log files. You can specify the full path to the log file directory or the folder name that stores the log files. If you specify the folder name only, the agent creates the folder in the agent installation directory.

Default: the log subdirectory contained in the agent installation directory

objmon.cpu.scalefactor

Specifies a scale factor to multiply the load averages of a CPU and allow the agent, when processing a CPU Monitoring job, to express the load average as a percentage. This scale factor is for busy machines that would otherwise always report 100 percent utilization.

Default: 100

Example: If you set the scale factor to 10, and the reported load average is 7, then the reported CPU usage would be 70 percent.

objmon.scaninterval

Specifies the interval, in milliseconds (ms), between successive scans for any Monitoring job that uses continuous monitoring.

Default: 10,000 milliseconds (10 seconds)

Note: A shorter interval puts a greater demand on system resources.

oscomponent.dumpenvironment

Specifies whether all environment variables are written to the agent spool file for every RUN job.

• false—Does not write environment variables to the spool file
• true—Writes all environment variables to the spool file

Default: false

oscomponent.libjvmpath

Specifies the path statement to the Java library location.

oscomponent.initialworkingdirectory

Specifies the default initial working directory for all scripts.

• SCRIPT—Sets the path to where the script resides
• USER—Sets the path to the home directory of the owner of the script
• PATH—Sets the path to an absolute path to where the script should run

If you do not specify a value, the parameter defaults to the path where the running cybAgent resides.

Note: You can override the InitialWorkingDirectory on a per-job basis by specifying a value for the PWD environment variable.

oscomponent.noexitcode

Specifies the exit code that tells the agent not to send a completion code to the scheduling manager host.

Limits: 1-255

Default: 255 for UNIX

oscomponent.noforceprofile

Specifies whether or not the agent allows loading a .profile/.login file based on the usual UNIX rules for sourcing .profile/.login. When set to false, if the loginshell is set to false and USER has not been specified in the job definition, no .profile/.login will be sourced.

• false—Allows the agent to load the .profile
• true—Prevents the agent from loading the .profile/.login

Default: false

Note: If oscomponent.loginshell is set to false and USER is not specified in the job definition, no .profile/.login will be sourced and oscomponent.noforceprofile is ignored.

oscomponent.noguardianprocess

Specifies whether or not the agent resumes tracking jobs that were active at the time when the agent is recycled.

• false—Returns the status of any active or inactive job when the agent restarts
• true—Does not return the status of jobs that ran at the time the agent went down. Fails UNIX jobs upon restart and returns the message "Lost Control".

Default: false

Note: To enable the default, you must also set the persistence.coldstart parameter to false or comment it out.

oscomponent.security.turbo

Specifies whether the agent loads the security.txt file into a fast-loading, binary format when the cybAgent process starts up. This setting applies to run jobs only. FTP jobs have separate security rules. When the agent checks security rules for authorizations, it will do so much more quickly when this parameter is set to true. Enabling this feature is particularly useful if you have a large, multi-line security file where the required processing may slow system operation.

• false—The agent refreshes security rules each run job.
• true—The agent loads security rules into a binary-formatted file and does not check security rules again unless a manual refresh is issued to the agent.

Default: false

oscomponent.umask

Provides support for the umask command. The three-digit octal code specifies the file and directory permissions that are turned off. The default value, 022, sets the following permissions:

File rw-r--r--

Directories rwxr-xr-x

Note: This parameter will only apply to files created by the agent such as a spool or log file.

persistence.coldstart

Specifies whether the agent performs a warm or cold start, as follows:

• false—Performs a warm start. The agent will try to use the existing databases. However, if there is sufficient damage, the agent will not start.
• true—Performs a cold start. All databases will be automatically destroyed and new ones opened. No manual intervention is required. This setting is recommended if there is extensive damage to the databases. The agent discontinues job monitoring after a cold start.

  Note: On UNIX systems, the agent continues monitoring after a cold start.

Default: false (agent performs a warm start)

persistence.gcinterval

Specifies the persistent garbage collector interval. The garbage collector will be invoked at the end of each transaction and will run at least every N milliseconds.

Default: 10 000 (10 sec)

runnerplugin.spool.clean.enable

Specifies whether or not the agent deletes spool files.

• false—Disables the spool file cleaner
• true—Enables the spool file cleaner

Default: false

Note: If enabled, the agent deletes spool files older than 10 days and checks the spool files every day by default. 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.