WA Agent For UNIX Linux Windows Impl ENU
WA Agent For UNIX Linux Windows Impl ENU
WA Agent For UNIX Linux Windows Impl ENU
Implementation Guide
r11.3, Third Edition
This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to
as the Documentation) is for your informational purposes only and is subject to change or withdrawal by CA at any time.
This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without
the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed
by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing
your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and
CA.
Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may
print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your
employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced
copy.
The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable
license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to
certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY
KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE,
DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST
INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE
POSSIBILITY OF SUCH LOSS OR DAMAGE.
The use of any software product referenced in the Documentation is governed by the applicable license agreement and such
license agreement is not modified in any way by the terms of this notice.
The manufacturer of this Documentation is CA.
Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions
set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or
their successors.
Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to
their respective companies.
CA Process Automation
CA Workload Automation AE
CA Workload Automation Agent for Micro Focus (CA WA Agent for Micro Focus)
CA Workload Automation Agent for Microsoft SQL Server (CA WA Agent for
Microsoft SQL Server)
CA Workload Automation Agent for Oracle E-Business Suite (CA WA Agent for
Oracle E-Business Suite)
CA Workload Automation Agent for Remote Execution (CA WA Agent for Remote
Execution)
CA Workload Automation Agent for Web Services (CA WA Agent for Web Services)
CA Workload Automation DE
Contact CA Technologies
Contact CA Support
For your convenience, CA Technologies provides one site where you can access the
information that you need for your Home Office, Small Business, and Enterprise CA
Technologies products. At http://ca.com/support, you can access the following
resources:
Online and telephone contact information for technical assistance and customer
services
Contents
Chapter 1: Introduction
11
19
21
Contents 5
47
55
6 Implementation Guide
93
97
101
105
Contents 7
123
141
147
8 Implementation Guide
179
Index
183
Contents 9
Chapter 1: Introduction
This section contains the following topics:
Intended Audience (see page 11)
Agents and Agent Plug-ins (see page 11)
CA WA Agent for UNIX or CA WA Agent for Linux (see page 12)
CA WA Agent for Windows (see page 14)
How a Scheduling Manager and Agents Communicate (see page 15)
Intended Audience
This document is for system administrators who are responsible for upgrading,
installing, and configuring agents.
You require knowledge of the operating system where the agent is installed and any
third-party products or software technology that the agent uses.
Notes:
The term Windows refers to any Microsoft Windows operating system supported by
the agent.
The UNIX instructions in this document also apply to Linux systems unless otherwise
noted.
Chapter 1: Introduction 11
12 Implementation Guide
Monitor the agent computer for CPU usage, disk space, IP address, process
execution, and text files.
Chapter 1: Introduction 13
Monitor the agent computer for CPU usage, disk space, IP address, process
execution, and text files.
Monitor the Windows agent computer for Windows event logs and the status of
Windows services.
14 Implementation Guide
Agent
Chapter 1: Introduction 15
Scheduling Manager
Agent
Makes decisions
Schedules jobs
Receiver Ports
A scheduling manager and agents each have TCP/IP ports to receive messages. The
receiver listens on its designated port for messages from one or more senders. When
the sender has messages to transmit, it connects to the port of the receiver, sends the
messages, and closes the connection.
Receiver port configuration is restricted as follows:
16 Implementation Guide
CA Workload Automation ESP Edition can have multiple receiver ports (for example,
to separate encrypted and unencrypted message traffic). Each of these ports can
receive messages from multiple agents.
An agent has only one receiver port. This port can receive messages from multiple
scheduling managers.
Chapter 1: Introduction 17
Review the system requirements in the CA Workload Automation Agent for UNIX,
Linux, or Windows Release Notes.
2.
3.
4.
5.
Install the agent on UNIX using an interactive program (see page 30) or install
the agent on Windows using an interactive program (see page 31).
6.
Note: For detailed instructions to complete these steps, see the documentation for
your scheduling manager (see page 179).
7.
8.
20 Implementation Guide
Distribute the load of the jobs across multiple agents. For example, you can run
different jobs for different business applications on the same computer. To run this
workload, you can install an agent for one business application and an agent for the
other business application and provide access at the agent level.
Important! If a computer with multiple agents is not available, all workload scheduled
on that computer is impacted. To avoid a single point of failure, we recommend that
you install agents across multiple computers.
For Linux:
/CA/WA_Agent_R11_3
For UNIX:
/CA/WA_Agent_R11_3
For Windows:
C:\Program Files\CA\WA Agent R11.3
YesPreserves the parameter settings from the previous release of the agent.
NoDoes not preserve the parameter settings from the previous release of the
agent.
Default: No
22 Implementation Guide
For UNIX:
/Cybermation/ESP System Agent
For Windows:
C:\Program Files\Cybermation\ESP_System_Agent
Because the scheduling manager uses agent names as file names, use standard
file-naming conventions for your operating system.
Input Port
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 11023 are reserved ports that require root access.
Number of Managers
Specifies the number of scheduling managers you want to configure to work with
the agent.
Default: 1
Manager n ID
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
Note: You can configure the agent to work with multiple scheduling managers by
adding additional scheduling manager definitions in the agentparm.txt file.
Manager n Address
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)
Notes:
You can specify a DNS name instead of the IP address for the scheduling
manager. However, your agent computer must be able to resolve the DNS
name at all times. 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 helps
ensure that the IP address can be resolved after DNS disruptions.
Manager n Port
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
24 Implementation Guide
Cipher Algorithm
Specifies the type of cipher algorithm the agent uses to encrypt and decrypt
messages sent to the scheduling manager. The agent supports the following types:
DESEDETriple Data Encryption Algorithm that applies the DES algorithm three
times to each data block.
Default: DES
Note: CA Workload Automation AE and CA Workload Automation CA 7 Edition
support only AES encryption. Consult the documentation for your scheduling
manager to determine which encryption types are supported.
Encryption Key
Defines the encryption key the agent uses to communicate with the scheduling
manager. The encryption key must be prefixed with 0x and followed by the number
of characters required for the chosen cipher algorithm:
Notes:
If you omit the 0x prefix, the keygen utility interprets the inputted value as a
16-character passphrase and not as a hexadecimal number. If you enter less
than 16 characters, the keygen utility appends the passphrase with spaces for
the missing number of characters. The keygen utility will internally encode the
16-character passphrase into a 32-character hexadecimal character AES
encryption key.
26 Implementation Guide
For UNIX:
/opt/CA/SharedComponents/Csam/SockAdapter/lib
For Windows:
C:\Program Files\CA\SharedComponents\Csam\SockAdapter\bin
Note: For UNIX systems, also specify the CA Workload Automation shared directory.
CA Workload Automation Shared Directory
Specifies the path to the shared components directory for CA Workload Automation
AE.
Default: /opt/CA/SharedComponents
Note: This path is required for UNIX systems.
Windows Service Name
Specifies the name for an agent installed on Windows that appears in the list of
Services. You can control the agent as a Windows Service.
Default: CA Workload Automation Agent 11.3
Windows Service Option
Sets how the agent, installed as a Windows Service, starts whenever the agent
computer is restarted:
Automatic
Manual
Default: Manual
28 Implementation Guide
Verify that the user account has the permissions to access the required directories
and run the commands and scripts located on the agent computer.
You can run the agent under the user account when the agent is installed under
root. However, you can only run jobs that belong to the user account. We
recommend that you install the agent using the specific user account to avoid
permission problems.
On AIXJRE 1.6 SR8 or higher (The supported JRE is 32-bit. The 64-bit JRE is not
supported.)
On z/LinuxJRE 1.6 SR8 or higher (The supported JRE is 31-bit. The 64-bit JRE is not
supported.)
java_binary_location
Specifies the full path to the Java binary located in the JRE directory.
Example: export PATH=/usr/java6/jre/bin:$PATH
Log on as root.
2.
Copy the setup file from the product CD or download a zip file from the CA Support
Online website, found at http://ca.com/support.
3.
Copy or FTP the setup file to the target system and directory.
4.
Type the following command to obtain execute permission for the setup file:
chmod +x
5.
(Optional) Set the IATEMPDIR environment variable to override the system temp
directory:
IATEMPDIR=/opt/CAWA/tempdir
export IATEMPDIR
tempdir
Specifies the path to a temporary directory the agent installation program uses
during the installation process.
6.
Press Enter.
The license agreement appears.
8.
9.
30 Implementation Guide
For AIX and z/Linux systems, you must have the required JRE installed and the
PATH environment variable set to complete the installation.
To comply with U.S. Government encryption standard FIPS 140-2, select AES
when you are prompted for the cipher algorithm.
If you are installing the agent on a Linux computer that is SELinux enabled, a
warning message appears. Change the default security context for IDL.
If you have problems with the agent installation, you can display debugging
information for troubleshooting purposes.
More information:
User Account Considerations for UNIX Installations (see page 29)
Display Debugging Information During Agent Installation (see page 148)
Agent Installation Options (see page 22)
Copy the setup file from the product CD or download a zip file from the CA Support
Online website, found at http://ca.com/support.
2.
Copy or FTP the setup file to the target system and directory.
3.
Double-click setup.exe.
The agent installation program opens.
4.
5.
6.
Review the settings and use the Back button to change the values you entered.
7.
8.
Click Finish.
The agent is installed and the settings are stored in the agentparm.txt file located in
the agent installation directory.
Note: If you have problems with the agent installation, you can display debugging
information for troubleshooting purposes.
More information:
Agent Error Messages on Windows (see page 165)
Display Debugging Information During Agent Installation (see page 148)
Agent Installation Options (see page 22)
2.
3.
32 Implementation Guide
2.
Edit the properties for the agent. Remove the # sign to uncomment each property
line.
3.
AGENT_INFO_1
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.
AGENT_INFO_2
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
NUM_MANAGER_N=N
Specifies the number of scheduling managers (N) the agent works with.
Default: NUM_MANAGER_1=1
MANAGER_n_INFO_1
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
34 Implementation Guide
MANAGER_n_INFO_2
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)
Notes:
You can specify a DNS name instead of the IP address for the scheduling
manager. However, your agent computer must be able to resolve the DNS
name at all times. 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 helps
ensure that the IP address can be resolved after DNS disruptions.
MANAGER_n_INFO_3
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
STRONG_ENCRYPTION_CIPHER
Specifies the type of cipher algorithm the agent uses to encrypt and decrypt
messages sent to the scheduling manager. The agent supports the following types:
DESEDETriple Data Encryption Algorithm that applies the DES algorithm three
times to each data block.
Default: DES
Note: CA Workload Automation AE and CA Workload Automation CA 7 Edition
support only AES encryption. Consult the documentation for your scheduling
manager to determine which encryption types are supported.
STRONG_ENCRYPTION_KEYGEN
Defines the encryption key the agent uses to communicate with the scheduling
manager. The encryption key must be prefixed with 0x and followed by the number
of characters required for the chosen cipher algorithm:
Notes:
If you omit the 0x prefix, the keygen utility interprets the inputted value as a
16-character passphrase and not as a hexadecimal number. If you enter less
than 16 characters, the keygen utility appends the passphrase with spaces for
the missing number of characters. The keygen utility will internally encode the
16-character passphrase into a 32-character hexadecimal character AES
encryption key.
STRONG_ENCRYPTION_FILE
Specifies the path to the text file that stores the encryption key for the agent.
LOCAL_SECURITY
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.
Default: off
The following properties apply if you want to connect the agent to an SNMP manager.
SNMP_MGMT_CONN
Enables an SNMP connector that lets you use an SNMP Manager to monitor and
control the agent. The agent supports SNMP v1, v2, and v3. This option requires the
SNMP Manager address and UDP port.
36 Implementation Guide
MGMT_SNMP_HOST
Identifies the SNMP Manager IP address or DNS name. Your SNMP administrator
can provide the host name.
Default: localhost
Example: 172.24.36.107
MGMT_CONN_AGENT_PORT
Specifies the SNMP GET/SET listening port.
Default: 161
Limits: 1-65535
JMX_PLUGIN
Enables a JMX connector that lets you use a JMX console to monitor and control the
agent. You can use any JMX console that implements JSR-160.
JMX_CONNECTOR_PORT
Specifies the port where the JMX connector listens.
Default: 1099
Limits: 1-65534
The following FTP properties apply if you want to configure the agent to run FTP
workload (see page 123).
FTP_PLUGIN
Enables the FTP plug-in on the agent, which lets you configure FTP client and FTP
server options.
Default: 0 (disabled)
FTP_SSL_CLIENT_ENABLED
Specifies whether the agent can act as an FTP client using Regular or Secure Sockets
Layer (SSL) encryption for FTP transfers.
Default: false
FTP_NO_SERVER
Sets whether the agent can act as an FTP server.
Default: false
FTP_SSL_SVR_ENABLED
Specifies whether the agent can act as an FTP server using regular or Secure Sockets
Layer (SSL) encryption for FTP transfers.
Default: false
FTP_SVR_PORT
Specifies the port number for the agent to act as an FTP server.
Default: 21
Limits: 1-65534
FTP_USER_ID
Specifies the FTP user ID required to access the FTP server.
FTP_PASSWORD
Specifies the password corresponding to the FTP user ID.
Limits: case-sensitive
FTP_PASSWORD_V
Confirms the FTP password.
The following SNMP properties apply if you want to configure the agent as an SNMP
Manager (see page 93).
SNMP_PLUGIN
Enables the agent to act as an SNMP Manager to emit and listen for SNMP traps.
This option lets users define and run SNMP job types. The agent supports SNMP v1,
v2, and v3.
Default: 0 (disabled)
38 Implementation Guide
SNMP_P_TRAP_PORT
Specifies the agent port listening for trap information.
Default: 162
Limits: 1-65535
CA_SOCKET
Enables a connection to CA Workload Automation AE using the CA Secure Socket
Adapter (SSA).
Default: 0 (disabled)
SSA_COMPONENT_PATH
Specifies the path to the *.so file (UNIX) or *.dll file (Windows) for communication
with CA Workload Automation AE using the CA Secure Socket Adapter.
Default:
For UNIX:
/opt/CA/SharedComponents/Csam/SockAdapter/lib
For Windows:
C:\Program Files\CA\SharedComponents\Csam\SockAdapter\bin
MANAGER_VARS_n_INFO_2
Specifies the path to the file that stores the environment variables, where n is an
integer that corresponds to the scheduling manager being configured.
Example: C:\\MANAGER_1\\FILE1.TXT
NUM_USER_VARS_2
Specifies the number of user environment variables for the scheduling manager.
Limits: 0-3
USER_VARS_n_INFO_1
Specifies the name of the user the environment variables apply to, where n is an
integer that corresponds to the scheduling manager being configured.
Example: USER1
USER_VARS_n_INFO_2
Specifies the path to the file that defines user-specific variables.
Example: C:\\USER1\\FILE1.TXT
LOOKUPCMD
Determines how to specify the script or command name (UNIX) or command file
(Windows) to run in a job definition.
falseThe full path to the script, command name, or command file must be
specified in the job definition.
Default: true
Notes:
40 Implementation Guide
If set to true, verify that the agent on UNIX is running under the root account.
The agent does not resolve environment variables specified in the command
file path for Windows jobs.
JOBLOG
Sets whether the agent creates a job log for each job that runs.
Default: true
WIN_SERVICE_n
Specifies the name for an agent, installed on Windows, that appears in the list of
Services, where n is an integer that corresponds to the scheduling manager being
configured. You can control the agent as a Windows Service.
Default: CA Workload Automation Agent 11.3
path
Specifies the path to the installer.properties file.
The agent is installed.
42 Implementation Guide
Accept the license agreement and enter the required information until you are
prompted for the AgentParm File Conversion.
3.
Select Yes.
4.
5.
6.
Copy the r11.3 installer.properties file to your agent computer. The file is available
on the product CD or CA Support Online website, found at http://ca.com/support.
2.
3.
4.
Enabling this property preserves the agentparm.txt settings of your existing agent.
5.
Enable and edit the following property to specify the path to the agentparm.txt file
for your existing agent:
#OLD_AGENT_PARM=C:\\Program Files\\Cybermation\\ESP System Agent
R7\\agentparm.txt
For example, if you have a Release 6 ESP System Agent installed in C:\\Program
Files\\Cybermation\\ESP System Agent R6\\agentparm.txt, edit the property as
follows:
OLD_AGENT_PARM=C:\\Program Files\\Cybermation\\ESP System Agent
R6\\agentparm.txt
6.
Verify that all other properties are disabled by adding the comment (#) character to
each property that is uncommented.
7.
8.
9.
44 Implementation Guide
2.
2.
3.
2.
3.
Click Start, Program menu to uninstall or run the uninstall file located in agentinstall
directory\UninstallData.
The Installation Type dialog opens.
4.
Click Uninstall.
The Uninstall Complete dialog opens when the uninstall is finished.
5.
Click Done.
The agent wizard closes.
46 Implementation Guide
Verify that the cybAgent process and related Java processes from the previous run
of the agent were shut down correctly.
2.
3.
More information:
Agent Will Not StartcybAgent Script is Missing (see page 168)
2.
cybAgent -a
Service_Name
Specifies the value defined by the oscomponent.servicedisplayname parameter
in the agentparm.txt file.
The agent starts.
2.
3.
Double-click Services.
The Services dialog opens.
4.
48 Implementation Guide
2.
3.
Double-click Services.
The Services dialog opens.
4.
5.
Select Automatic from the Startup type drop-down list on the dialog.
6.
Click OK.
The agent is set to start automatically the next time it starts up.
2.
3.
2.
2.
cybAgent -s
Service_Name
Specifies the value defined by the oscomponent.servicedisplayname parameter
in the agentparm.txt file.
The agent stops.
50 Implementation Guide
2.
3.
Double-click Services.
The Services dialog opens.
4.
Verify the status fileThe status file shows whether the agent is running or a
controlled shutdown has occurred.
Verify the agent processThe agent process status can verify whether the agent is
down, which is helpful when a controlled shutdown did not occur and the status file
does not show the correct status.
2.
2.
To check a separate Java process before a new start, enter # ps -ef | grep Java.
2.
52 Implementation Guide
2.
3.
Double-click Services.
The Services dialog opens.
4.
Locate the agent service name and check the Status column.
2.
2.
Stop the agent. At the command prompt, enter the following command:
On UNIX:
./cybAgent -s
On Windows:
cybAgent -s
4.
5.
6.
Start the agent. At the command prompt, enter the following command:
On UNIX:
./cybAgent &
On Windows:
cybAgent -a
56 Implementation Guide
0, 1, or 2Creates logs for any errors including the receiver and transmitter
logs. Level 2 is adequate for production, unless problems arise requiring more
details for troubleshooting.
3Adds queues. If this value is specified, the agent ignores the log.maxsize
parameter.
4 or 5Adds debugging information. Use log level 5 for setup and initial
testing.
Default: 5
Example: log.level=2
log.archive
Defines the log archiving options:
Default: 0
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
three, 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:
Because the scheduling manager uses agent names as file names, use standard
file-naming conventions for your operating system.
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 11023 are reserved ports, which require root access.
58 Implementation Guide
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
Note: CA Workload Automation DE does not require this parameter. z/Linux
systems use plain socket types only.
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.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)
Notes:
You can specify a DNS name instead of the IP address for the scheduling
manager. However, your agent computer must be able to resolve the DNS
name at all times. 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 helps
ensure that the IP address can be resolved after DNS disruptions.
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.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 systems use plain socket types only.
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.cryptkey
Specifies the path to the text file that stores the encryption key for the agent.
Default:
For UNIX:
/CA/WA_Agent_R11_3/cyrptkey.txt
For Windows:
C:\Program Files\CA\WA Agent R11.3\cryptkey.txt
60 Implementation Guide
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
core.health.monitor.enable
Specifies whether resource usage information within the Java Virtual Machine
(JVM), such as memory usage and threads information, must be logged.
trueLogs the resource usage information within the JVM to a file named
simple_health_monitor.log in the log folder
Default: true
Note: The log.level parameter must be set to 5 or greater to log this information.
spooldir
Specifies the path to the spool file directory.
Default: spool subdirectory of the agent installation directory
oscomponent.javapath
Specifies the full path to the directory where Java resides.
oscomponent.jvm
Specifies the Java virtual machine (JVM) to use.
Note: Do not change the value set by the agent installer.
plugins.start_internal_n
Specifies the agent plug-in to start by the core Java agent.
n
Denotes an integer assigned to the agent plug-in, starting at 1. The n suffix
must increase sequentially for each agent plug-in.
oscomponent.classpath
Specifies the path to jar files required by the agent.
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.host
Identifies the SNMP Manager IP address or DNS name. Your SNMP administrator
can provide the host name.
management.snmp.port
Specifies the SNMP Manager UDP port. Your SNMP administrator can provide this
port number.
Default: 162
Limits: 1-65535
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.
Default: public
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.serverport
Specifies the port number for the agent to act as an FTP server.
Default: 21
Limits: 1-65534
62 Implementation Guide
ftp.client.ssl
Specifies whether all FTP jobs on the agent computer automatically use SSL
communication.
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: You can use the agent password utility to encrypt your password before using
it in the agentparm.txt file.
ftp.server.ssl
Specifies that the FTP server handles both non-SSL and SSL FTP.
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)
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:
jmxSpecifies a JMX connector, built into the agent, that lets you use a JMX
console to monitor and control the agent.
snmpSpecifies an SNMP connector, built into the agent, that lets you use an
SNMP manager to monitor and control the agent.
management.jmx.port
Specifies the port where the JMX connector listens.
Default: 1099
Limits: 1-65534
oscomponent.servicename
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: CA Workload Automation Agent 11.3
oscomponent.servicedisplayname
Specifies the name for an agent installed on Windows that appears in the list of
Services. You can control the agent as a Windows Service.
Default: CA Workload Automation Agent 11.3
oscomponent.loginshell
Indicates how to invoke the Shell program when executing a script.
trueThe agent invokes the shell as a login shell when you specify true. The
shell program looks in the directory specified by the HOME environment
variable and tries to execute the login scripts of the user (in addition to the
.cshrc script).
Default: false
Note: For most systems, this parameter affects only the C and Korn shells. The
Bourne shell ignores the oscomponent.loginshell parameter.
oscomponent.defaultshell
Identifies the shell in which scripts are run on the system.
Default: /bin/sh
oscomponent.validshell
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 selected 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.checkvalidshell
Determines whether the agent checks valid shells.
trueThe agent checks valid shells. All shells that jobs use must be specified in
the oscomponent.validshell parameter.
Default: true
64 Implementation Guide
oscomponent.lookupcommand
Determines how to specify the script or command name (UNIX) or command file
(Windows) to run in a job definition.
falseThe full path to the script, command name, or command file must be
specified in the job definition.
Default: true
Notes:
If set to true, verify that the agent on UNIX is running under the root account.
The agent does not resolve environment variables specified in the command
file path for Windows jobs.
oscomponent.joblog
Sets whether the agent creates a job log for each job that runs.
Default: true
communication.inputport.aux
Optional. Specifies the auxiliary port number the agent uses to listen for incoming
messages from the scheduling manager.
communication.manageraddress_n
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)
Notes:
You can specify a DNS name instead of the IP address for the scheduling
manager. However, your agent computer must be able to resolve the DNS
name at all times. 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 helps
ensure that the IP address can be resolved after DNS disruptions.
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.
66 Implementation Guide
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
plain
dylan
Default: plain
Note: CA Workload Automation DE does not require this parameter.
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: CA Workload Automation DE does not require this parameter.
Note: You can configure the agent to work with multiple scheduling managers by adding
additional definitions in the agentparm.txt file.
Example: Configure the Agent to Communicate with a Scheduling Manager
In this example, the following configuration parameters are set in the agentparm.txt file
for a scheduling manager running under the instance ACE at address 130.200.146.134.
The scheduling manager listens for incoming messages from the agent on port 49155:
communication.inputport=7520
communication.managerid_1=ACE
communication.manageraddress_1=130.200.146.134
communication.managerport_1=49155
communication.monitorobject_1=CAEWA_AGENT/AGENTMON1.0/MAIN
communication.receiver.socket.main=plain
communication.socket_1=plain
More information:
Agent Parameters in the agentparm.txt File (see page 57)
More information:
Configure Agent Parameters on the Agent (see page 56)
68 Implementation Guide
By default the agent uses plain socket ports for communication. Although you can
change to SSA communication, we do not recommend it.
CA Secure Socket Adapter (SSA) lets CA Workload Automation AE and the agent use a
single multiplexed communication port to ease firewall administration.
To configure SSA communication with CA Workload Automation AE, follow these steps:
1.
2.
Configure the agent to communicate using SSA ports (see page 72).
3.
Define the agent SSA port on CA Workload Automation AE (see page 74).
4.
Set the $DISPLAY environment variable to use X-terminal or unset it to use console
mode.
2.
3.
Note: The setup script performs various system checks, which can take a few
minutes.
After the system checks are complete, the CA Common Components panel appears
with Next selected.
4.
Press Enter.
The License Agreement panel appears.
5.
6.
7.
Select Next.
The Installation Path panel appears.
8.
Enter the path to the directory where you want to install SSA, and select Next.
The Review Settings panel appears.
9.
70 Implementation Guide
Insert the CA Common Components media into the DVD drive of the computer
where you want to install the agent.
The CA Common Components Product Explorer dialog opens.
2.
3.
Click Next.
The License Agreement appears.
4.
5.
6.
7.
Enter the path to the directory where you want to install SSA, and select Next.
The Review Settings panel appears.
8.
value
Specifies the SSA port number of the agent. This port must not be in use by
another application.
3.
4.
5.
6.
port
Specifies the SSA port number configured using the csamconfigedit command.
7.
72 Implementation Guide
8.
On UNIX:
oscomponent.classpath=jars/*.jar:jars/ext/*:common_components_installatio
n_path/Csam/SockAdapter/lib/casocket.jar
On Windows:
oscomponent.classpath=jars/*.jar;jars/ext/*;common_components_installatio
n_path/Csam/SockAdapter/bin/casocket.jar
common_components_installation_path
Specifies the path to the directory where the CA common components are
installed.
UNIX Default: /opt/CA/SharedComponents
Windows Default: C:\Program Files\CA\SC
Note: Append the location of the casocket.jar file to the classpath to specify the
location of CA Secure Socket Adapter.
9.
Specify one of the following subcommands in a JIL script or at the jil command line:
machine_name
Specifies the name of the agent defined on CA Workload Automation AE.
2.
port_number
Specifies the port that CA Workload Automation AE uses to listen for traffic. If
you configured SSA on the agent, this value is the agent port number
configured using the csamconfigedit command. This value must match the
communication.input port parameter in the agentparm.txt file for the agent.
The SSA port is defined in the machine definition for the agent on CA Workload
Automation AE.
Note: For more information about JIL subcommands and attributes, see the CA
Workload Automation AE Reference Guide.
74 Implementation Guide
Agent-wide variables that are available for every job from every scheduling
manager on behalf of every user.
Manager-specific variables that are available for every job from a specific
scheduling manager on behalf of every user. These variables override agent-wide
variables.
User-specific variables that are available for every job from a specific user. These
variables override agent-wide variables and manager-specific variables.
2.
If the agent is running as root, the agent reads a user-specific variables file using the
root authority and does not check permissions of the file for the user specified in a
job definition. This rule also applies to manager-specific variables files.
On Windows, the total environment variable file size must not exceed 16 KB.
oscomponent.loginshell=true
oscomponent.lookupcommand=true
76 Implementation Guide
To specify job classes and number of initiators, configure the following agent
parameters on the agent:
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.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.
Example: Set the Job Class and Number of Initiators
Suppose that you want to limit the number of Web Service jobs the agent initiates to
100. In this example, the job class is defined as WS. The following agent receiver log
contains the verb and subverb: WEBSERVICE and RUNRPC.
AM STRESS HELLO4.TXT/OA.1/MAIN WEBSERVICE RUNRPC TargetNS(http://tempuri.org/)
Operation(HelloWorld)
WSDLURL(http://138.42.98.127:3247/WebSite3/Service.asmx?WSDL)
ServiceName(Service) PortName(ServiceSoap)
Note: The verb and subverb in the agent receiver log follow the job ID,
HELLO4.TXT/OA.1/MAIN.
78 Implementation Guide
To set the job class and number of initiators, you configure the following parameters to
the values shown.
initiator.class_1=Default,1000
initiator.class_2=WS,100
initiators.afmjobclassmap_1=WEBSERVICE,RUNRPC,WS
NoticeThe agent sends a warning notice when the disk space reaches this level
but continues to run.
SevereThe agent sends a severe warning and stops accepting new automated
framework messages (AFMs).
The agent logs the severe and critical warning messages in the
runner_os_component.log and nohup.stderr logs.
To configure the agent to monitor available disk space
1.
2.
3.
4.
size
Specifies the amount of disk space in bytes (B), kilobytes (K), megabytes
(M), or gigabytes(G).
Default: 21M
agent.resourcemon.threshold.disk.warning.severe
Specifies the amount of disk space required before the agent sends an SNMP
trap and stops accepting new automated framework messages (AFMs). 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
Note: The agent resumes accepting new AFMs when the available disk space is
greater than the size specified by this parameter.
agent.resourcemon.threshold.disk.critical
Specifies the amount of disk space required before the agent shuts down. 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
6.
7.
Important! To send SNMP traps, you must configure the agent to connect with an SNMP
manager.
More information:
Configure the Agent to Connect with an SNMP Manager (see page 102)
SNMP-related Problems (see page 169)
80 Implementation Guide
2.
3.
2.
3.
4.
5.
6.
7.
82 Implementation Guide
The target computer MAC address. Represented in a '-' or ':' separated list of six
octets (bytes) in hexadecimal format.
The optional IP address to which the agent attempts the connection to verify that
the target host is up.
The optional list of ports to which the agent attempts the connection to verify that
the target host is up.
Defaults: 21, 22, 23, 80, 111, 135, 139, 445
The optional WOL password. Must be 4 or 6 '.', '-', or ':' separated octets (bytes) in
hexadecimal format.
For detailed instructions to define a WOL job, see the documentation for your
scheduling manager.
Default: false
2.
3.
4.
5.
6.
7.
More information:
Problems with Windows Interactive Jobs (see page 170)
84 Implementation Guide
2.
Configure the agent service to run under the local system account option (see
page 86).
The local system account is the default set when the agent is registered as a
Windows service.
2.
From the command prompt, change to the agent installation directory, and issue
the following command:
cybAgent -install
2.
From a command prompt, change to the agent installation directory, and issue the
following command:
cybAgent -remove
Configure the Agent Service to Run Under the Local System Account
When you register the agent as a Windows service, the service is configured to run
under the local system account by default. If you must reconfigure the agent service to
run under the local system account, follow these steps:
1.
2.
3.
4.
Double-click Services.
5.
6.
7.
8.
9.
Click OK.
When running Windows programs as a service, you are restricted to how you can access
data on remote computers.
Under a system account, note the following:
No user is running the process and, therefore, the service has limited access to
network resources, such as shared directories and pipes.
Services use null session support to interact with the desktop and can connect to
resources using a null session.
When a program is started using the system account, it logs on with null credentials. If it
tries to access a remote resource using a null session, it fails. To avoid this problem,
specify the user ID under which resources are accessed in your job definition. Using this
approach, you do not have to modify the Registry.
86 Implementation Guide
You can also have the system administrator change Registry values, however, we do not
recommend this practice. Using the Registry Editor can cause serious problems, which
can require reinstallation of the Windows operating system. If you change the Registry
values, do one of the following:
Set the value of the RestrictNullSessAccess parameter to FALSE (the default value is
TRUE).
Specify lists of share names and pipe names accessed by the system account, using
the NullSessionShares and NullSessionPipes parameters respectively. These names
must be specified on the computers where the resources exist. By default, the only
share names the agent service can access are those names listed with the
NullSessionShares parameter.
Note: Verify that you are complying with the terms of the agent license agreement
before accessing network resources with the agent. In most situations, you are
permitted to access data on remote computers. Scripts or executable files run by the
agent, however, must use the CPU and memory of the computer where the agent
resides.
2.
3.
4.
Double-click Services.
5.
6.
7.
8.
9.
88 Implementation Guide
2.
user
Specifies the user that requires authentication.
password
Specifies the encrypted password corresponding to the user.
Note: Use the password utility to encrypt the password
pam_service
Optional. Specifies the PAM service that authenticates the user.
The chkusr utility displays a validation message.
Example: Testing user authentication settings
The following command tests the sshd PAM service for the osuser.
$ ./chkusr osuser FD5AD34EC7A8F07C0B2BE8 sshd
More information:
Encrypt a Password Using the Password Utility (see page 121)
You can force the agent to use the default shell defined by the
oscomponent.defaultshell parameter in the agentparm.txt file.
To force the default shell for UNIX jobs
1.
2.
3.
4.
5.
6.
falseUses the first, as well as subsequent scans, for the file system activity
monitoring.
Default: false
Note: You can set this parameter to true for backward compatability with AutoSys
agents.
90 Implementation Guide
filemon.update.firstscan.skip
Sets whether the agent skips the first scan of a monitored file for UPDATE activity
with no change.
falseUses the first, as well as subsequent scans, for the file system activity
monitoring.
Default: false
Note: This parameter applies to File Trigger jobs, and when set to true, emulates R7
agent behavior.
Scan files using a specified user ID on a UNIX or Linux system, letting the agent scan
NFS file systems that the local root user does not have access to
2.
3.
4.
Set the following parameter to let the agent start as an external process and
communicate using Named Pipes (Windows) or SysV IPC (UNIX/Linux) queues:
filemonplugin.runexternal=true
5.
Specify the following parameter to set a default user for submitting jobs:
oscomponent.default.user
Specifies the default operating system user name.
Note: The user specified in a job definition overrides this value.
6.
7.
8.
2.
3.
4.
The agent will execute a temporary shell script without sourcing the users profile.
5.
The agent drops the sourcing of the profiles into the temporary shell script.
6.
92 Implementation Guide
If the job profile is present, the agent sources the job profile. The
EWAGLOBALPROFILE (/etc/auto.profile) is not sourced.
7.
8.
falseDisables translation.
trueEnables translation.
Default: false
snmp.response.translate.full
Sets whether the agent translates the Object Identifiers (OIDs) from the numeric
format to the string format.
Default: false
snmp.request.timeout
Defines the time-out, in milliseconds (ms), when the agent requests SNMP trap
information.
Default: 2000 (ms)
snmp.request.retries
Defines the maximum number of times the agent requests SNMP trap information.
Zero indicates one attempt.
Default: 0
Default: 2
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.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.v3.auth.password_n
Specifies the encrypted authentication password for the SNMP v3 user, where n is
an integer starting from 1.
Note: All parameters ending with the same value of n belong to the same group.
This parameter applies only to SNMP v3.
94 Implementation Guide
snmp.trap.listener.v3.auth.protocol_n
Specifies the authentication protocol of the SNMP trap listener, where n is an
integer starting from 1.
Note: 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.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.
Note: 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.
Note: 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.user_n
Specifies the user authorized to communicate with the SNMP v3 agent, where n is
an integer starting from 1.
Note: All parameters ending with the same value of n belong to the same group.
This parameter applies only to SNMP v3.
snmp.response.translate
snmp.response.translate.full
The agent attempts the translation prior to checking an SNMP Subscribe job filter
against the OIDs. If the translation fails, the agent uses the OIDs in numeric format.
The agent logs the information sent in the SNMP VarBinds in the plugin_log_snmp.log
and is prefixed with "Matching string for WOB ID".
96 Implementation Guide
2.
Enable the agent aliasing on the scheduling manager (see page 98).
Install the agent on a partition mounted locally on each node of the cluster.
2.
Verify that each agent has its own copy of the agentparm.txt file, log directory, and
log files. These files must reside on a locally mounted partition.
3.
Configure the spooldir parameter in the agentparm.txt file to help ensure that the
agents of the cluster share a common spool directory.
Note: Sharing a common spool directory ensures that, when failover occurs and a
workload object restarts on another node, the agent can retrieve the spool file and
continue updating it as required.
4.
Node A
Node B
Agentname
AGENTA
AGENTB
Communication.alias_1
PKG1
PKG1
Communication.alsias_2
PKG2
PKG2
Persistence.coldstart
FALSE
FALSE
Spooldir
shareddisk/dir/spool
shareddisk/dir/spool
98 Implementation Guide
1.
2.
Select Keep alive only for the physical agent, not for the alias agents you configured
for application packages.
In job definitions, schedulers must refer to aliased agents, not physical agents.
Discover metrics
To configure the agent to connect to a JMX console, configure the following agent
parameters on the agent:
management.connector_n=jmx
Identifies the type of management connector the agent uses to connect to an
external application, where n is an integer starting from 1.
Specify jmx to allow a JMX console 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
Discover metrics
Default: 2
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.host
Identifies the SNMP Manager IP address or DNS name. Your SNMP administrator
can provide the host name.
management.snmp.port
Specifies the SNMP Manager UDP port. Your SNMP administrator can provide this
port number.
Default: 162
Limits: 1-65535
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.
Default: public
management.snmp.agent.community.read
Specifies the SNMP read community. This parameter applies only to SNMP v1 and
v2.
management.snmp.agent.community.write
Specifies the SNMP write community. This parameter applies only to SNMP v1 and
v2.
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.community
Specifies the SNMP community that receives trap information.
Default: public
management.snmp.agent.trapsink.user
Specifies the user authorized to receive trap information.
Types of Security
At a minimum, security is set between the agent and the scheduling manager using an
encryption key. The agent requires encrypted communication with the scheduling
manager. The encryption key is set when you install the agent and when you configure
the scheduling manager to work with the agent.
You can also set up local security on the agent to control the following:
Which scheduling manager user IDs can submit jobs under a specific agent user ID,
from a specific directory
Which FTP user IDs can issue FTP-related commands to files in directories
Which scheduling manager user IDs can issue control commands and send
messages to an agent
Types of Security
The scheduling manager verifies the access privileges of the user it has even before
sending workload to the agent. The scheduling manager also verifies security when
receiving messages from the agent. The agent also has its own security verifications it
performs when it receives instructions from the scheduling manager.
How to Set Up Security between the Agent and the Scheduling Manager
2.
3.
Set the encryption key on the scheduling manager (see page 110).
4.
5.
Note: For more information about security permissions, see the documentation for your
scheduling manager.
How to Set Up Security between the Agent and the Scheduling Manager
2.
key
Defines the encryption key the agent uses to communicate with the scheduling
manager. The encryption key must be prefixed with 0x and followed by the
number of characters required for the chosen cipher algorithm:
Limits: 16-64 alphanumeric characters (any digits and letters A-F only)
Notes:
If you omit the 0x prefix, the keygen utility interprets the inputted value as
a 16-character passphrase and not as a hexadecimal number. If you enter
less than 16 characters, the keygen utility appends the passphrase with
spaces for the missing number of characters. The keygen utility will
internally encode the 16-character passphrase into a
32-character hexadecimal character AES encryption key.
How to Set Up Security between the Agent and the Scheduling Manager
cipher
Specifies the type of cipher algorithm the agent uses to encrypt and decrypt
messages sent to the scheduling manager. The agent supports the following
types:
Default: DES
Note: CA Workload Automation AE and CA Workload Automation CA 7 Edition
support only AES encryption. Consult the documentation for your scheduling
manager to determine which encryption types are supported.
destination
(Optional) Specifies the name of a text file that stores the encryption key.
Default: cryptkey.txt
Note: If you specify a new text file, update the security.cryptkey parameter in
the agentparm.txt file.
The keygen utility replaces the encryption key.
Example: Encrypt a Key
This example encrypts the key 0x1020304050607080 for 16-character (DES) encryption.
keygen 0x1020304050607080 DES
How to Set Up Security between the Agent and the Scheduling Manager
2.
3.
4.
5.
6.
2.
On UNIX:
./cybAgent -s
On Windows:
cybAgent -s
On UNIX:
./cybAgent &
On Windows:
cybAgent -a
If you did not select the AES cipher algorithm when you installed the agent, you can
configure the agent to comply with encryption standard FIPS 140-2.
2.
3.
4.
Set the following parameter for the agent to use the FIPS-certified library and
cipher algorithm.
security.jce.fips=true
Note: Setting this parameter can impact workload that uses SSL, for example, FTP
jobs where the servers do not use the same cipher suites.
6.
7.
More information:
Configure Agent Parameters on the Agent (see page 56)
Set the Encryption on the Agent Using the Keygen Utility (see page 108)
Note: Agent security rules do not override permissions set at the operating system level.
To set up local security on the agent, follow these steps:
1.
2.
3.
2.
3.
4.
5.
2.
Define security file rules in the security.txt file (see page 114).
3.
Defines a rule that allows or denies the scheduling manager user IDs from
submitting jobs that run under a specific user ID, from a specific directory. These
rules begin with the letter x.
x
Identifies a rule controlling execution of scripts and commands.
a|d
Specifies whether access is allowed or denied.
manager_userID
Defines the scheduling manager name or the scheduling manager user ID this
rule applies to.
agent_userID
Defines the user ID on the agent computer under which the job runs.
path
Defines the path that the scheduling manager is allowed to submit jobs from,
using the user ID identified by agent_userID. Paths are case-sensitive.
Note: On CA Workload Automation AE, jobs are always submitted to run under the
user specified in the owner attribute. If local security is enabled on the agent, the
agent verifies the permissions of the job owner only. The agent does not verify the
CA Workload Automation AE user who submits the job. For CA Workload
Automation AE, you can define the security rule as follows:
x a | d job_owner agent_userID path
job_owner
Defines the user specified in the owner attribute.
f a | d FTP_userID operation path
Defines a rule that allows or denies FTP user IDs from issuing FTP-related
commands to files in specified directories. These rules begin with the letter f.
f
Identifies FTP commands.
a|d
Specifies whether access is allowed or denied.
FTP_userID
Defines the FTP user ID this rule applies to.
operation
Specifies the FTP command. Valid commands are as follows:
These commands apply to the agent as FTP server. For FTP jobs, only read and
write commands apply.
path
Specifies the path that the scheduling manager is allowed to submit jobs from,
using the user ID identified by FTP_userID. Paths are case-sensitive.
Defines a rule that allows or denies scheduling manager user IDs the authority to
issue control commands to the agent. These rules begin with the letter c.
c
Identifies a rule controlling operational commands to an agent.
a|d
Specifies whether access is allowed or denied.
manager_userID
Defines the scheduling manager name or the scheduling manager user ID this
rule applies to.
command
Specifies the control command. Valid commands are shutdown, refresh, flush,
quiesce, and restart. You can also specify an asterisk (*) for all commands.
Note: On CA Workload Automation AE, you can use this rule to allow or deny the
authority to issue the autoping command or to add the scheduling manager
instance to the agent. For CA Workload Automation AE, you can define the security
rule as follows:
c a | d instance_* * *
instance
Specifies the CA Workload Automation AE instance.
Notes:
Specify at least one rule of each type (x, f, and c) in the security.txt file.
Agent security rules do not override permissions set at the operating system level.
To specify an f rule that restricts access to a directory itself (not the contents in the
directory), the directory path must end with a forward slash.
The following rule denies any scheduling manager user from submitting jobs under gem,
or any user IDs that begin with gem, from all directories.
x d * gem* +
The following rule allows any scheduling manager user to submit jobs as root that are
named employee, or begin with employee, from the /prod/ directory.
x a * root /prod/employee+
The following rule allows any scheduling manager user to submit jobs that use any
object whose name starts with F in the USER library. The user can submit the jobs under
any user profile that starts with the characters USR on the agent computer.
x a * USR* /QSYS.LIB/USER.LIB/F*
The following rule allows any scheduling manager user to submit jobs that use any
object whose name starts with F in the USER library. The user can submit the jobs under
any user profile that starts with the characters JO on the agent computer. Members of
file objects whose names start with F are included.
x a * JO* /QSYS.LIB/USER.LIB/F*
The following rule denies any scheduling manager user from submitting jobs that use
/QSYS.LIB/MLIB.LIB/DEPT.FILE/PAYROLL.MBR on the agent computer.
x d * * /QSYS.LIB/MLIB.LIB/DEPT.FILE/PAYROLL.MBR
The following rule allows all users to list the files in /pub/ftp and its subdirectories:
f a * list /pub/ftp/+
The following rule allows all users to store files, rename files, and make directories in
/pub/ftp/upload and its subdirectories:
f a * write /pub/ftp/upload/+
The following rule allows all users to read files from /pub/ftp/download and its
subdirectories:
f a * read /pub/ftp/download/+
The following rule allows the autoping command to be issued to the agent from the ACE
instance:
c a ACE_* * *
Explanation
If both rules are generic, the more specific /u1/jsmith/scripts/* overrides /u1/jsmith*
one overrides the other.
/u1/jsmith/scripts/a* overrides
/u1/jsmith/scripts*
If there is still ambiguity after these rules
have been applied, a deny rule overrides
an allow rule.
If local security is enabled, the agent then looks for the security.txt file.
If the security.txt file does not exist, default security rules apply.
If the security.txt file exists, the agent uses the rules defined in the file. The
agent does not use the default security rules. If a request does not have a
match in the security file, the agent denies the request.
If local security is not enabled, the agent does not verify security.
The following default security rules apply when the security file does not exist and agent
security is turned on in the agentparm.txt file (security.level=on):
x a * * +
x d * root +
c a * * *
f a * * +
Test the Encryption between the Agent and the Scheduling Manager
Change to the agent installation directory, and enter the following command:
3.
Download an ASCII or binary file from a remote FTP server to your agent computer
Upload an ASCII or binary file from your agent computer to a remote FTP server
You can set up the agent to run as an FTP client, FTP server, or both.
The following diagram shows you the relationships between the agent running as an FTP
client, a scheduling manager, and an FTP server.
The following diagram shows you the relationships between the agent running as an FTP
server, a scheduling manager, and another agent running as an FTP client.
2.
Define FTP rules for local security on the agent (see page 127).
This step only applies if local security is enabled on the agent.
3.
Define the FTP user on the scheduling manager (see page 128).
Note: You can also set up the agent to use Secure (SSL) FTP.
2.
3.
4.
Add the plugins.start_internal_n parameter for the FTP plug-in. The n suffix must
increase sequentially for each agent plug-in.
Example: plugins.start_internal_5=ftp
5.
Define the following parameter if you are using Internet Protocol version 6 (IPV6):
ftp.passive=true
6.
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:
A password for the local user ID is not required on the scheduling manager.
ftp.passive
Specifies whether the agent FTP client uses a passive mode connection, as
follows:
Default: false
Note: We recommend 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, and/or the FTP
server opens a listening port for the data channel.
7.
8.
Configure the Agent FTP Client to Use Secure Copy Protocol (SCP)
You can configure the agent to act as an FTP client that uses the secure copy protocol
(SCP) to transfer binary files.
To configure the agent for secure copy file transfers, configure the following agent
parameters on the agent:
ftp.client.updatemsg
Specifies the status update interval in milliseconds (ms).
Default: 30000 (ms)
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:
A password for the local user ID is not required on the scheduling manager.
ftp.scp.sshd.timeout
Controls the timeout, in milliseconds (ms), for SCPv2.
Default: 30000 (ms)
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.
falseDisables debugging.
trueEnables debugging.
Default: false
More information:
Security File Rules (see page 114)
Refresh an Agent Security File (see page 120)
2.
3.
The agent as an FTP server can handle ASCII and binary transfers, wildcard requests,
simple GET and PUT requests for single files, and MGET and MPUT requests for multiple
files. The agent has a secure store of FTP server user IDs and associated passwords. The
ftpusers.txt file, located in the directory that contains the agent program files, stores
these user IDs and their corresponding hashed passwords.
The agent running as an FTP server does not support anonymous FTP requests. For audit
purposes, the agent provides a detailed log of all FTP requests.
2.
3.
4.
Add the plugins.start_internal_n parameter for the FTP plug-in. The n suffix must
increase sequentially for each agent plug-in.
Example: plugins.start_internal_5=ftp
5.
6.
7.
8.
2.
3.
2.
Enter the following command from a command line on the same computer as the
agent:
-a
Adds a new user ID. Use with the userID and password parameters. Enter the
user ID first followed by the password.
-d
Deletes the specified user ID. Use with the userID parameter.
-m
Changes the password for the specified user ID. Use with the userID and
password parameters. Enter the userID first followed by the password.
-l
Lists all entries in the ftpuser.txt file. The utility does not show passwords in
plain text.
userID
Specifies the FTP user ID you want to add, change, or delete.
password
Specifies the password corresponding to the FTP user ID. Passwords are case
sensitive.
Note: Issuing the ftpusrcfg command without a parameter displays a list of options.
3.
Defines default SSL server and client parameters in the agentparm.txt file.
You can use the default certificates and settings to configure SSL FTP. You can also
generate a certificate and apply your own settings to configure SSL FTP.
In the SSL FTP server directory, export the certificate used by the SSL FTP server, for
example:
jre\bin\keytool -export -alias agentname -file key.cer -keystore serverkeystore
agentname
Specifies the name of the agent.
You are prompted for a password. The default password is cyberuser.
Note: You require the alias agent to ensure that you use the certificate provided
by the agent.
2.
Copy the created file, in this case, key.cer, to the SSL FTP client directory if it is
different from the server directory.
3.
Import the created file, in this case, key.cer, into the truststore file supplied by Sun
(cacerts), for example:
D:\agent\R6SP2>jre\bin\keytool -import alias agentname -file key.cer -keystore
cacerts
Enter keystore password: changeit
Owner: CN=cyberuser, OU=ESP System Agent, O=Cyber, L=Markham, ST=Ont, C=CA
Issuer: CN=cyberuser, OU=ESP System Agent, O=Cyber, L=Markham, ST=Ont, C=CA
Serial number: 4152d5dc
Valid from: Thu Apr 21 09:55:40 EDT 2005 until: Mon Jun 05 09:55:40 EDT 2006
Certificate fingerprints:
MD5: 74:F2:17:20:B6:B0:10:AE:AC:88:9A:BA:AA:3A:6D:73
SHA1:4C:88:B6:39:64:65:98:AD:3E:1E:33:05:12:13:9C:4A:F4:4E:E7
:FA
Trust this certificate? [no]: yes
Certificate was added to keystore
4.
5.
2.
3.
4.
5.
Add the certificate to the client keystore on the agent (see page 137).
6.
Note: After you configure SSL FTP, you can enable and disable it as required. If SSL is
disabled on the FTP client after configuration and you want to run SSL FTP workload,
you can specify SSL in the job definition instead.
2.
3.
4.
5.
6.
7.
123456
Cyberuser
agent
Cybermation
Markham
Ontario
CA
yes
Enter key password for [set AGENT value for your book](RETURN if same as keystore
password):
2.
3.
123456
39:D8:D9:4F:50:1C:43:A2:27:4D:50:75:32:E9:9D:40
SHA1: 98:30:54:C0:F7:4E:34:FF:DC:0A:85:D8:F7:98:D6:B7:41:7D:E7:58
3.
4.
5.
2.
3.
4.
5.
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.
The default password is cyberuser (encrypted).
Note: You can use the agent password utility to encrypt your password before
using it in the agentparm.txt file.
6.
7.
Export the certificate from the server keystore (see page 137).
2.
Import the certificate to the client keystore on the agent (see page 138).
3.
2.
Note: To export the certificate generated with an alias, include the same alias in the
export command. For example, suppose a certificate was generated with the
following command:
keytool -genkey -alias agent -keystore ./serverkeystore
3.
654321
2.
To import a certificate that was exported with an alias, include the same alias in the
import command. For example, suppose a certificate was exported with the
following command:
keytool -export -alias agent -file key.cer -keystore serverkeystore
3.
changeit
31:CC:29:0F:B6:C8:E9:3C:70:C7:6B:6C:AD:B7:00:38
SHA1:9D:86:A7:51:15:9E:B1:D3:E7:3B:59:C6:B2:E0:E0:3F:3D:C6:97:6
Trust this certificate? [no]:
yes
2.
3.
changeit
2.
3.
4.
5.
6.
7.
2.
3.
4.
5.
6.
7.
The agent deletes spool files that are older than 10 days.
Example: Check Spool Files When the Sleep Interval Is Greater Than the File Expiration
Time
Suppose that you want to configure the agent to review the spool files every 50 minutes
and delete spool files that are older than 50 minutes as specified by
runnerplugin.spool.expire.
Add the indicated values to the following parameters in the agentparm.txt file:
runnerplugin.spool.clean.enable=true
runnerplugin.spool.expire=50M
runnerplugin.spool.sleep=2H
The agent ignores the two hour sleep interval set by runnerplugin.spool.sleep.
More information:
Configure Agent Parameters on the Agent (see page 56)
Define the ESPAGENTDIR environment variable with the path to agent installation
directory.
The agent installation directory must contain a valid agentparm.txt file.
2.
n
Specifies the maximum number of days a spool file is maintained. The
clearspool command removes all files older than n days.
debug
Optional. Displays messages to the command prompt as the clearspool
command runs.
Example: Clearing spool files older than five days
The following command deletes all files older than five days.
clearspool 5
2.
3.
4.
Edit the following parameter to specify the maximum log size (in bytes).
log.maxsize
When the log file exceeds the specified size, the agent archives it and starts a new
log file.
5.
Note: The agent ignores the log.maxsize value if the log.archive parameter is set to
3. The agent does not create an archive file, but appends new log entries to the
current logs.
6.
Edit the following parameter to specify the types of logs and number of logs to
generate:
log.level
Note: Level 2 is adequate for general, initial testing, and level 0 is adequate for
production unless problems arise requiring more details for troubleshooting.
7.
8.
More information:
Agent Parameters in the agentparm.txt File (see page 57)
Default: true
Note: The agent stores the job logs in the spool file directory, which you must clear
periodically depending on the volume of your workload. You can also configure the
agent to delete job logs automatically when jobs complete successfully.
More information:
Configure the Agent to Automatically Delete Job Logs (see page 146)
Your system opens a separate text screen during the agent installation process that
displays debugging information.
Your PATH environment variable defines the path to the Java bin directory.
You know the path of the directory the agent is installed in.
If you need the required permissions or the path to Java on your machine, see your
system administrator.
To collect log files for agents running on UNIX
1.
Create a temporary directory for the jar file. For example, if the Service Request
number is 12345, type the following command:
cat /dev/null > /tmp/sr12345_logfiles.jar
2.
Create the jar file. For example, type the following command on one line:
find /<AgentInstallDirectory>/log -type f -mtime -2 -exec jar uvf
/tmp/sr12345_logfiles.jar {} \;
Note: The find command above limits the amount of data included in the jar file
using the -mtime switch. In the above example, -mtime -2 includes all log files
whose last modified data is within the last two days.
3.
FTP the jar file, using binary mode, to a machine where you can email CA.
4.
Email the jar file to CA. Check that the jar file name includes the service request
name. Identify the service request number on the subject line of your email.
Note: Emails sent to CA cannot exceed 5 megabytes. If the file is greater than 5
megabytes, please contact the Product Specialist investigating your issue for
assistance.
2.
3.
4.
Create temporary directories. For example, if the service request number is 98765,
type the following commands:
mkdir C:\sr98765
cd C:\sr98765
mkdir logfiles
5.
Xcopy the agent log files to the temporary directory. For example, type the
following commands:
xcopy "<AgentInstallDirectory>\log\*" C:\sr98765\logfiles /S /q
6.
Create the jar file. For example, type the following commands:
jar cf C:\temp\sr98765_logfiles.jar C:\sr98765\logfiles
7.
Email the jar file to CA. Check that the jar file name includes the service request
name. Identify the service request number on the subject line of your email.
Note: Emails sent to CA cannot exceed 5 megabytes. If the file is greater than 5
megabytes, please contact the Product Specialist investigating your issue for
assistance.
job
Specifies the name of the job.
hash
Specifies the encryption key that the agent uses to encrypt messages.
Example: Using a Job Log to Debug a Failed Job
A job, running on a Windows system, fails. The agent records the following message in
the job log named x.E61ADD84CD3C0864D155EEADD4EEECA6D509D23E.joblog.
20071125 20342154+0500 . MBAGENT X/Y/Z State SUBERROR Failed SetEnd Status(Error
creating stdin file) Cmpc(20004) JobLogId(E61ADD84CD3C0864D155EEADD4EEECA6D509D23E)
User(MBAGENT) Host(workstation)
More information:
Enable or Disable Job Logs (see page 146)
Agent Logs
Agent Logs
The agent provides logging facilities to assist in testing and debugging. The logging
facilities can specify logging targets, message levels, and buffering processing.
The agent supports log levels 0, 1, 2, 3, 4, and 5, where level 0 provides the least
information and level 5 provides the most.
Levels 0, 1, and 2 create logs of any errors including the receiver and transmitter
logs.
When you install the agent, the log level is set to 5 by default.
In a standard agent installation, the agent maintains the log files in a directory named
log, which resides in the agent installation directory.
5Adds debugging information. Use log level 5 for setup and initial testing, and
diagnosis of problems.
Agent Logs
More information:
Agent Parameters in the agentparm.txt File (see page 57)
Configure Agent Parameters on the Agent (see page 56)
Step
Log File
Description
Log Level
receiver.log
0, 1, 2
queue_receiver.log
0, 1, 2
Step
Log File
Description
Log Level
queue_inbox.log
initiatormanager.log
initiators_waiting_<Job
class>.log
rmipluginmanager.log
plug-in specific
rmipluginmanager.log
10
queue_communicator.log
11
initiatormanager.log
12
13
transmitter.log
Log File
Description
Log Level
receiver.log
0, 1, 2
Step
Log File
Description
Log Level
queue_receiver.log
0, 1, 2
queue_inbox.log
initiatormanager.log
initiators_waiting_<Job
class>.log
rmipluginmanager.log
plug-in specific
rmipluginmanager.log
10
queue_communicator.log
11
initiatormanager.log
12
13
transmitter.log
Log File
Description
Log Level
runner_os_component.log
0, 1, 2
Log File
Description
Log Level
file_mon_plugin_threads.log
You can also specify the polling interval for logging the information using the
core.health.monitor.interval parameter. The default is 60 000 ms (1 min). 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.
Note: If the Micro Focus agent plug-in is installed, enter the following command:
chcon -t texrel_shlib_t /<AgentInstallDirectory>/cybMFCommand
Verify permissions. Change them to allow the agent to open the file.
2.
2.
Verify that the correct shell is specified in the agentparm.txt file. Alternatively, you
can set the oscomponent.checkvalidshell=false parameter in the agentparm.txt file,
so that the agent does not validate whether the shell is valid.
2.
Verify that the corresponding job definition has the correct shell specified in the
shell statement.
3.
In the first line of a script file, the shell and its path must match exactly what you
specified in the oscomponent.validshell parameter.
2.
Action:
1.
You must have a user ID that has administrator authority to run the agent.
2.
You have multiple agents trying to use the same ports. The following parameters
must be unique for each agent:
agentname
communication.inputport
In addition to the parameters above, the following parameters must be unique for each
agent on Windows:
oscomponent.servicename
oscomponent.servicedisplayname
Another process has a port in use that the agent needs. Issue the netstat command to
determine what ports are in use. For example,
netstat -na
Another process may be intermittent and may not be accessing the agent ports at the
time you issue the netstat command.
The scheduling manager and the agent have different encryption keys.
The scheduling manager and the agent have different values for the parameters
that must match.
2.
3.
4.
5.
6.
After verification, correct the values of the JVM_DOT or JVM_PATH variables, and rerun
the silent installer.
SNMP-related Problems
SNMP-related Problems
This section provides error messages related to the SNMP management connector.
CybSnmpPluginDriver terminated: java.net.BindException: Permission denied
Reason:
The SNMP communication port specified by the snmp.trap.listener.port agent
parameter is already in use. The agent uses ports below 1024. On UNIX, start the agent
as root.
Action:
Ensure that the value specified for the SNMP communication port
(snmp.trap.listener.port) is not in use by another application. The default port number is
162.
java.lang.IllegalArgumentException: Passed ip address is invalid
Reason:
SNMP v1 does not support IPv6.
Action:
To ensure that the agent uses IPv4, add the following parameters to the agentparm.txt
file:
java.net.preferIPv4Stack=true
java.net.preferIPv6Stack=false
Check that the password of your FTP user ID is correct on the scheduling manager.
2.
If the agent runs as an FTP server, check that the user ID and password are also
defined on the agent.
Note: If you update the ftpusers.txt file, restart the agent for your changes to take
effect.
Password is missing
Reason:
A problem with the FTP user ID exists.
Action:
1.
Check that the FTP user ID specified in the job definition is correct.
2.
Check that the same FTP user ID is defined on the scheduling manager.
3.
If the agent runs as an FTP server, check that the user ID and password are also
defined on the agent.
Note: If you update the ftpusers.txt file, restart the agent for your changes to take
effect.
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: 60000 (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: 30000 (30 seconds)
Note: This parameter does not apply to CA Workload Automation AE.
ftp.client.separator
Specifies the character that is 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:
log.archive
Defines the log archiving options:
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 computers that would otherwise always
report 100 percent use.
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: 10000 (10 seconds)
Note: A shorter interval puts a greater demand on system resources.
oscomponent.checksuid
Sets whether the agent checks the script setuid or setguid attributes. If set to true,
allows execution of the script only if setuid or setguid bit is set.
Default: false
Note: For more information about possible SUID error messages, see Agent Error
Messages on UNIX.
oscomponent.dumpenvironment
Specifies whether all environment variables are written to the agent spool file for
every RUN job.
Default: false
oscomponent.libjvmpath
Specifies the path statement to the Java library location.
oscomponent.initialworkingdirectory
Specifies the default initial working directory for all scripts.
USERSets the path to the home directory of the owner of the script
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, 127 for Windows
oscomponent.noforceprofile
Specifies whether 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.
Default: false
Note: If oscomponent.loginshell is set to false and USER is not specified in the job
definition, no .profile/.login is sourced and oscomponent.noforceprofile is ignored.
oscomponent.noguardianprocess
Specifies whether the agent resumes tracking jobs that were active at the time
when the agent is recycled.
falseReturns the status of any active or inactive job when the agent restarts
trueDoes 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, set the persistence.coldstart parameter to false or
comment it out.
oscomponent.noswitchsuid
Specifies whether the agent verifies the presence of setuid or setguid bits on the
script.
trueThe agent will setuid to the owner of the script only if the script has the
setuid or setguid bit on.
Default: false
Note: If oscomponent.noswitchsuid=true and setuid/setgid bit is not on, then a
script runs using the authority of the agent (generally root). In this case, as there is
only one agentparm.txt per agent installation, the true value would work for scripts
with s (set user or group id) set on. However, with scripts which do not have s set
on, the script runs under the authority of the agent.
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 does so much more quickly when this parameter is set to true.
Enabling this feature is useful when you have a large, multi-line security file where
the required processing slows system operation.
trueThe 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 only applies 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:
falsePerforms a warm start. The agent tries to use the existing databases.
However, if there is sufficient damage, the agent does not start.
truePerforms a cold start. All databases are 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
Note: If enabled, the agent deletes spool files older than 10 days, or 7 days for CA
Workload Automation AE, 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.
Documentation
Documentation
Define jobs
Documentation
Configure the agent to work with CA Workload Automation ESP Edition Installation
the scheduling manager
and Configuration Guide
Define jobs
Documentation
Index
A
active jobs, limiting the number 77
agent
AFMs 154
description 11
parameters 57, 172
security 105
spool file maintenance 141
status 52, 53, 83
uninstall process 45
agent files
log files 144
spool files 141
agent parameters
used for troubleshooting 172
agentparm.txt file
converting a previous release 43, 44
parameters 57
auto_remote, configuring 92
automated computer startup, configuring 81
automated framework messages (AFMs), tracing
154
C
CA Workload Automation AE
agent installation files 21
auto_remote configuration 92
configuring SSA 69
clustered environment, using agent aliasing 97
communication
between agents and scheduling managers 15
configuring 65
considerations 99
console mode, description 49
D
description 11, 84
disk space monitoring, configuring 79
display debugging console 148
E
encrypting and changing 121
encryption
disabling 110
F
file triggers, run as separate processes 91
FTP client
setup process for the agent 124
using the agent as 123
FTP server
setup process for the agent 128
using the agent as 123
G
global variables, specifying a path on UNIX 76
I
installation
error log 42
multiple agents on a single computer 22
options 22
process 19
installer properties file, configuring 33
UNIX jobs, default shell 90
interactive jobs, setting up on Windows 84
IPV6 communication, configuring 68
J
Java Runtime Environment (JRE)
logging resource usage 158
PATH environment variable 29
requirement 29
JMX console, using with the agent 101
job classes, defining 77
job logs
enable or disable 146
for troubleshooting 151
job types, supported 13, 14
Index 183
L
Linux agent, function See UNIX agent, function
local security, setting up 113
log files
clear automatically 145
collecting for support 149, 150
log levels 152
maintenance 144
setting for troubleshooting 152
structure 152
O
operating system errors, reporting in agent status
83
P
problems running the agent 51
S
scheduling manager
configure agent parameters 56
configuring agent communication 65
required information 20
security permissions 107
Secure Socket Adapter (SSA), description 69
security
changing the encryption 108
local on the agent 113
security.txt file 114
setting up on the agent 107
types 105
silent installation
example 41
process 32
properties 33
SNMP
W
wake on LAN
description 81
Windows Agent, function 14
Windows console mode
starting the agent 49
stopping the agent 51
Windows installation
configuring the agent as a Windows Service 85
debugging mode 49, 51
interactive install 31
running agent in console mode 49
silent install 42
starting agent as a Windows Service 48, 49
Index 185