ca workload automation agent for hp integrity nonstop workload...unifstat utility—checks status of...

Implementation Guide Release 11.3.1

CA Workload Automation Agent for HP Integrity NonStop

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 © 2012 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

CA Technologies Product References

This document references the following CA Technologies products:

■ CA Network and Systems Management

■ CA Universal Job Management Agent (CA UJMA)

■ CA Workload Automation Agent for HP Integrity NonStop (CA WA Agent for HP Integrity NonStop), formerly Tandem NSK

■ CA Workload Automation AE

■ CA Workload Automation ESP Edition

■ CA Workload Automation CA 7 Edition

■ CA Workload Control Center (CA WCC)

■ CA Service Desk Manager

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

■ Information about user communities and forums

■ Product and documentation downloads

■ CA Support policies and guidelines

■ Other helpful resources appropriate for your product

Providing Feedback About Product Documentation

If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected].

To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs.

http://www.ca.com/support

mailto:[email protected]

http://www.ca.com/docs

http://www.ca.com/docs

Contents 5

Contents

Chapter 1: Introduction 9

Intended Audience ....................................................................................................................................................... 9

Agents .......................................................................................................................................................................... 9

CA WA Agent for HP Integrity NonStop ..................................................................................................................... 10

Job Types Supported by CA WA Agent for HP Integrity NonStop .............................................................................. 10

How a Scheduling Manager and Agents Communicate ............................................................................................. 11

Receiver Ports ..................................................................................................................................................... 11

Communication Configuration Example ............................................................................................................. 12

How Local Security Works .......................................................................................................................................... 12

Supported Scheduling Managers ............................................................................................................................... 13

Chapter 2: Installing the Agent 15

How to Set Up the Agent ............................................................................................................................................ 15

Installation Considerations ......................................................................................................................................... 16

HP Integrity NonStop Updates ............................................................................................................................ 16

Collect Information about the Environment .............................................................................................................. 17

Install the Agent ......................................................................................................................................................... 18

Reinstall the Agent ..................................................................................................................................................... 23

Uninstall the Agent ..................................................................................................................................................... 25

Chapter 3: Controlling the Agent 27

unicycle Utility—Recycles Functions and Related Services ........................................................................................ 27

unistart Utility—Starts the Agent Components ......................................................................................................... 28

unishutdown Utility—Shuts Down Functions and Related Services .......................................................................... 28

unifstat Utility—Checks Status of the Agent Functions ............................................................................................. 28

Start the Agent ........................................................................................................................................................... 29

Stop the Agent............................................................................................................................................................ 29

Configure Automatic Startup ..................................................................................................................................... 29

Verify the Status of the Agent .................................................................................................................................... 29

Display Agent Version Procedure Information ........................................................................................................... 30

Chapter 4: Maintaining Spool and Log Files 31

Spool File Maintenance .............................................................................................................................................. 31

Spool File Retrieval .............................................................................................................................................. 33

Agent Log File Maintenance ....................................................................................................................................... 33

6 Implementation Guide

AFM Logs ............................................................................................................................................................. 34

Console Logs........................................................................................................................................................ 34

EMS Logs ............................................................................................................................................................. 35

Tracing ........................................................................................................................................................................ 35

Standard Streams ....................................................................................................................................................... 35

Chapter 5: Configure Additional Options 37

Configure Communications ........................................................................................................................................ 37

Configuration Files ..................................................................................................................................................... 38

CACCICFG.CCIPRF File .......................................................................................................................................... 38

SERVICES File ....................................................................................................................................................... 39

CAUNI.CAOPTS File.............................................................................................................................................. 39

CAUNI.MOMOPTS File......................................................................................................................................... 41

CAHOSTS File ....................................................................................................................................................... 42

Environment Variables—User Configurable .............................................................................................................. 43

CAI-CCI-DEBUG—Enable or Disable Tracing ........................................................................................................ 43

CAI-CONLOG—CAIOPR Log File for HP Integrity NonStop .................................................................................. 43

CAI-DATEFMT—Date Format .............................................................................................................................. 44

CAI-LOG-SUBVOL—Logs Stored in the Specified Subvolume .............................................................................. 45

CAI-OPR-CONFIG—CAIOPR File ........................................................................................................................... 45

CAISCHD0006— CA WA Agent for HP Integrity NonStop Log Files ..................................................................... 45

CAISCHD0008— CA WA Agent for HP Integrity NonStop Temporary Files ......................................................... 45

CAISCHD0010—Size of Workload Log File .......................................................................................................... 45

CAI-TRACE-SUBVOL—Traces the Files Stored in Subvolume .............................................................................. 46

HOST-FILE-LOCATION—CAHOSTS File Location .................................................................................................. 46

JOBLOG—Create Job Log .................................................................................................................................... 46

JOBLOG-AUTO-CLEANUP—Job Log Automatically Cleaned ................................................................................ 47

LOG-ROLLOVER-TIME—Automatic Log Rollover Based on Time ........................................................................ 47

LOG-ROLLOVER-SIZE—Automatic Log Rollover Based on Size ............................................................................ 47

RESP-RETRY-INTERVAL—Sets Minimum Time for Response Retries .................................................................. 48

SPOOL-AUTO-CLEANUP—Automatically Deletes the Spool File ......................................................................... 48

SPOOL-FILE-DELETE—Enable or Disable Purging of Spool Files .......................................................................... 49

SPOOL-FILE-EXPIRY—Delete Spool Files Older than Specified Value .................................................................. 49

SPOOL-SLEEP-TIME—Specify the Duration of Spool File Storage ....................................................................... 50

SPOOL-VOLUME—Location of Spool Files........................................................................................................... 50

TCPIP-PROCESS-NAME—Specify the User Response to the Prompt .................................................................. 50

WLA-AGENT-NAME—Name of the Agent ........................................................................................................... 51

WLA-PASSW-REQUIRED—Password Required.................................................................................................... 51

Environment Variables—Expert Configurable ........................................................................................................... 51

CACONSOLE—Virtual Home Terminal for HP Integrity NonStop Processes ....................................................... 52

CAI-CAMSGF-OPRDIRECT—Messages to EMS Log .............................................................................................. 52

Contents 7

CAI-EXE—Executable Volume and Subvolume ................................................................................................... 52

CAIGLBL0000—CA WA Agent for HP Integrity NonStop Installation Volume ..................................................... 52

CAI-LOCAL-NODE—Installation Expand Name .................................................................................................... 52

CAIMESSAGE—HP Integrity NonStop Message File ............................................................................................ 52

CAI-MSGREADER—Message Router ................................................................................................................... 53

CAISCHD0001—Workload Management Executables ........................................................................................ 53

CAISCHD0002—Metacharacters in JOBPARM Statement................................................................................... 53

CAISCHD0030—Previous Version Compatibility ................................................................................................. 53

CAI-TCPIP-HOSTNAME—Installation Host Name ................................................................................................ 53

CA-OPERA-NODE—Console Daemon Node ........................................................................................................ 54

CAOPR-EMS—EMS Distributor Parameters ........................................................................................................ 54

CAOPR-EMS-NAME—EMS Distributor Process Name ......................................................................................... 54

EXECUTABLES-VOLUME—Location of Executables ............................................................................................. 54

TCPIP-HOST-FILE—Host File Used by CAICCI ....................................................................................................... 54

Index 55


Chapter 1: Introduction

The purpose of this guide is to introduce you to CA Workload Automation Agent for HP Integrity NonStop. This agent replaces both the Unicenter Universal Job Management Agent for Tandem (CA Workload Automation AE) and the Tandem Agent (CA Workload Automation ESP Edition). This guide provides you an overview of the product and familiarizes you with the installation and configuration of the product.

This section contains the following topics:

Intended Audience (see page 9) Agents (see page 9) CA WA Agent for HP Integrity NonStop (see page 10) Job Types Supported by CA WA Agent for HP Integrity NonStop (see page 10) How a Scheduling Manager and Agents Communicate (see page 11) How Local Security Works (see page 12) Supported Scheduling Managers (see page 13)

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.

Agents

Agents are the key integration components of CA Workload Automation products. Agents let you automate, monitor, and manage workload on all major platforms, applications, and databases. CA Workload Automation Agent for HP Integrity NonStop provides cross-platform scheduling capabilities to the various CA Workload Automation scheduling managers by enabling them to schedule and track jobs across platforms. The scheduling manager initiates a job. CA Workload Automation Agent for HP Integrity NonStop processes the request, monitors the job, and provides the scheduling manager with event information for status updates. Users can view the CA WA Agent for HP Integrity NonStop generated messages through CA Event Management. CA Common Services (CCS) or CA NSM Job Management Option provides Event Management.

To run workload on a particular system, you install an agent on that system. The ability for the agent to accept jobs from many CA Workload Automation scheduling managers demonstrates the integration of CA Workload Automation solutions.

CA WA Agent for HP Integrity NonStop


The agent supports the following CA Workload Automation scheduling managers:

■ CA Workload Automation AE

■ CA Workload Automation CA 7 Edition

■ CA Workload Automation ESP Edition

CA WA Agent for HP Integrity NonStop

CA WA Agent for HP Integrity NonStop runs on the HP Integrity NonStop operating system, enabling the scheduling manager to submit and run workload on that platform.

The CA WA Agent for HP Integrity NonStop lets a user perform tasks such as the following:

■ Execute commands or scripts

■ Pass environment variables to the commands or scripts

■ Retrieve spool files

■ Verify the current job status of a given job

■ Monitor files

Job Types Supported by CA WA Agent for HP Integrity NonStop

With the CA WA Agent for HP Integrity NonStop, you can define and run native jobs with the appropriate command syntax. On CA Workload Automation AE, native jobs are named command jobs. On CA Workload Automation ESP Edition and CA Workload Automation CA 7 Edition, these are Tandem or NonStop jobs. In future releases of the scheduling managers, job types will be added or modified to run this workload.

You can now define a File Monitoring job to monitor file activity for HP Integrity NonStop systems. The File Monitoring job can monitor when a file is created or updated.

Note: For more information about scheduling HP Integrity NonStop workload and monitoring file activity, see the documentation for your scheduling manager.

How a Scheduling Manager and Agents Communicate


How a Scheduling Manager and Agents Communicate

Agents receive and respond to commands sent by the scheduling manager and transmit data and messages back to the scheduling manager. A scheduling manager and agents communicate by sending Automated Framework Messages (AFMs) to each other. Communication is asynchronous using message queues through TCP/IP ports. For example, while the scheduling manager is sending a new job request to an agent, that agent can be sending completion status for another job.

The following table summarizes the relationship between the scheduling manager and agents:

Scheduling Manager Agent

Is aware of the entire network Is aware of the local environment

Sends commands and parameters to the agents

Responds to commands and parameters sent by the scheduling manager

Receives data from the agents Transmits data to the scheduling manager

Makes decisions Takes direction from the scheduling manager

Schedules jobs Runs jobs on different platforms

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:

■ CA Workload Automation AE and CA Workload Automation CA 7 Edition have only one receiver port. The receiver port can receive messages from multiple agents.

■ 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.

How Local Security Works


Communication Configuration Example

The following diagram shows some possible communication configurations between two scheduling managers and agents.

■ Scheduling Manager 1 (CA Workload Automation AE) communicates with Agent 1 and Agent 2 and receives messages from both agents through port 7001. Scheduling Manager 1 sends messages to port 9004 on Agent 1 and port 9005 on Agent 2.

■ Scheduling Manager 2 (CA Workload Automation ESP Edition) communicates with Agent 2 and Agent 3 and receives messages from Agent 2 through port 7002 and from Agent 3 through port 7003. Scheduling Manager 2 sends messages to port 9005 on Agent 2 and port 9006 on Agent 3.

How Local Security Works

You must define a user ID and password on the scheduling manager that is registered with the HP Integrity NonStop system. For example, you must use the Manage user@host users option of the autosys_secure command to define the user ID and password on CA Workload Automation AE and the PASSWORD command on CA Workload Automation ESP Edition.

This user ID and password are validated on the agent using the HP Integrity NonStop API named USER_AUTHENTICATE. This validation is optional for the password and is controlled by the WLA-PASSW-REQUIRED parameter in CAOPTS, the agent configuration file.

Supported Scheduling Managers


The HP Integrity NonStop file system provides a built-in access mechanism to the job executable file or script. If a user executes a job and does not have execute or read permissions, a file system error (48) is displayed, indicating a security violation. When this occurs, the job goes into a SUBERROR state and is sent back to the submitting scheduling manager.

Supported Scheduling Managers

This agent works with the following CA Workload Automation scheduling managers:

Scheduling Manager Release

CA Workload Automation AE r11.3 and higher

CA Workload Automation CA 7 Edition r11.3 and higher

CA Workload Automation ESP Edition r11.3 and higher


Chapter 2: Installing the Agent


How to Set Up the Agent (see page 15) Installation Considerations (see page 16) Collect Information about the Environment (see page 17) Install the Agent (see page 18) Reinstall the Agent (see page 23) Uninstall the Agent (see page 25)

How to Set Up the Agent

This topic describes the general process you follow to get your agent up and running. To install the agent, you first download the package and copy it to a local HP Integrity NonStop volume. Then, you unpack the package by executing a script. Some configuration options are requested during the installation, so it is important to collect the required information before you begin. You can change additional configuration options and set up security features after the agent is installed.

To enable the agent in your environment, follow these steps:

1. Review the installation considerations (see page 16) in this guide and the system requirements in the Release Notes.

2. Collect information about the environment (see page 17).

3. Install the agent (see page 18).

4. (Optional) Additional configuration options (see page 37).

5. Start the agent (see page 29).

6. Verify the status of the agent (see page 29).

Note: Some of these steps are covered in subsequent chapters.

Installation Considerations


Installation Considerations

CA WA Agent for HP Integrity NonStop must be installed on each system that processes the scheduling requests from scheduling managers running CA Workload Automation. You can only run one instance of the new agent on a system at a time.

Note: The name must be unique across all agents on all platforms connected to a single manager.

Important! If an earlier version of Unicenter Universal Job Management Agent (UUJMA) is installed on the system, you must uninstall UUJMA before you install CA WA Agent for HP Integrity NonStop.

HP Integrity NonStop Updates

Installation and activation of CA WA Agent for HP Integrity NonStop functions and services update the following volumes, subvolumes, and files:

Volume, Subvolume, or File Backup Version

$SYSTEM.SYSTEM.TACLLOCL $SYSTEM.SYSTEM.PURGEME

TCP/IP services file None

$SYSTEM.CAUNI.CONNECT $SYSTEM.CAUNI.PURGEME

Node Names

CA WA Agent for HP Integrity NonStop uses TCP/IP to provide communication between the HP Integrity NonStop server and the scheduling manager. Each node in the TCP/IP network has a node name (host name). Both the HP Integrity NonStop server and the scheduling manager must comply with these restrictions. TCP/IP node names must be 64 characters or less in length and use only alphanumeric characters.

CPU Assignments

The CA Workload Automation Agent for HP Integrity NonStop installs with primary and backup CPU assignments set to 0, 1, or both. You can change these CPU assignments during the installation.

Collect Information about the Environment


File System Security Considerations

The CA Workload Automation Agent for HP Integrity NonStop consists of executable programs, configuration files, TACL scripts, temporary files, and log files. The agent is installed under the SUPER.SUPER user ID, which assures that file security will not be a problem for the agent executables, configuration files, and scripts during the agent installation. However, as it processes job requests, the agent creates temporary files, spool files, and job logs. These files are created under the HP Integrity NonStop user ID sent by the scheduling manager, which is not necessarily the SUPER.SUPER ID. If the HP NonStop Integrity Safeguard security subsystem, or a comparable third-party security system, is in place on the system, security must allow for the handling of temporary, spool file, and job log files.

To avoid security issues that could prevent the agent from processing jobs, configure your system’s security such that a job’s user ID has read, write, execute, and purge capabilities on the subvolumes named SP*, *CFG, and *LOG on the agent installation volume.

Collect Information about the Environment

During the agent installation, you are prompted for information about your scheduling manager and about the agent environment. To collect this information, review the following prompts and enter the appropriate values. If necessary, speak to your administrator to determine the appropriate values.

Information Your Value

ID of the scheduling manager with which the agent will communicate

Location where the scheduling manager is installed; can be either the hostname that can be resolved DNS or an IPv4 address

Port on which the scheduling manager is installed

Name to use for the agent; must be unique across all agents on all platforms connected to a single manager

Port on which to install the agent

Fully qualified filename of the SERVICES file to be used for the TCP/IP port registration

Name of the TCP/IP process to be used by the agent, prompted for only if more than one TCP/IP process is running on the HP Integrity NonStop system

Install the Agent


Name of the host where the agent is to be installed or reinstalled.

Install the Agent

You install CA WA Agent for HP Integrity NonStop using an interactive program that prompts you for the required information.

To install CA WA Agent for HP Integrity NonStop

1. Log in as SUPER.SUPER.

2. Download the CAWAPAK installation package to the location from which the agent is to be installed. This may be a temporary local drive and not where you plan to actually install the agent.

If you download the CAWAPAK file to a computer with an operating system other than HP Integrity NonStop, and later tranfer the file to your HP Integrity NonStop system, you should check to see if the file code is set to 1729 by running the following command:

FUP INFO pak_filename

If the file code is not set to 1729, you should change the file code using the following command:

FUP ALTER pak_filename,CODE 1729

pak_filename

Specifies the name of the PAK file.

Example: CAWAPAK

3. Decompress the installation package using the following command:

UNPAK CAWAPAK, *.*.*, VOL volume_name, LISTALL

volume_name

Specifies the volume where the agent is to be installed.

4. Go to the CARELSCR subvolume. For example, type “volume volume_name.CARELSCR”.

CARELSCR is the subvolume where the files are placed after the execution.

5. Type the following command to start the installation:

RUN CASETUP

The agent installation program opens.

Note: If it finds agent files already exist, the installation program performs a reinstallation instead.

Install the Agent


6. Continue with the installation by entering the required information.

Depending on the current state of your system, the prompts received during installation vary. The installation program may include any of the following prompts:

Did you receive CA WA Agent for HP Integrity NonStop in a compressed file?

Indicates whether you received the agent in a compressed file.

■ Y—Received the agent in a compressed file.

■ N—Did not receive the agent in a compressed file. If you choose N, the name of the TAPE device containing the agent files must be provided to continue the installation.

Default: Y

Do you want to continue CASETUP?

Indicates whether you want to update the configuration files necessary for the installation. CASETUP is an installation script that is required for the agent installation.

■ Y—Updates the configuration files necessary for the installation.

■ N—Exits the program installation without updating any configuration files.

Default: Y

Enter the fully qualified name of the SERVICES file:

Specifies the name of the service file that contains the TCP/IP port numbers required to establish a connection.

Would you like the SERVICES file to be modified for a port entry?

Indicates whether you want to modify the SERVICES file to change the port number.

■ Y—Modifies the SERVICES file to change the port number.

■ N—Does not modify the SERVICES file to change the port number.

Default: N

Enter new port number:

Specifies the new port number of the agent.

Default: 1721

Example: 7051

Install the Agent


Do you want to run INSTALL now?

Indicates whether you want to complete the installation by configuring the agent.

■ Y—Completes the installation by configuring the agent.

■ N—Exits the program installation without configuring the agent. When you restart the installation program, the installation continues from this point.

Default: Y

Enter the volume on which you are going to install or have installed the product:

Specifies the name of the volume where you want to install the agent. We generally recommend entering the same volume where you originally installed the agent unless circumstances prevent you from doing so.

Example: $c36

Do you want to accept the defaults?

Indicates whether you want to accept all the defaults.

■ Y—Accepts all the defaults. The defaults are as follows:

To install all the agent functions.

To use the mm/dd/yyyy date format for all functions.

To modify the $SYSTEM.SYSTEM.TACLLOCL file so that all users will be attached to the agent TACL segment file.

Note: You can update the corresponding files to change the default values after the installation. For example, you can edit the CAOPTS file (see page 39) to change the value of the subvolume name in the CAI-TRACE-SUBVOL parameter.

■ N—Does not accept all the defaults.

Default: Y

Install the Agent


Specify a name for the agent CA WA Agent for HP Integrity NonStop 11.3.1:

Specifies a name for the agent. The name must be unique across all agents on all platforms connected to a single manager.

Example: PROAGENT

Enter the manager ID:

Specifies the name of the scheduling manager instance that the agent works with.

Example: abc1

Enter the manager address:

Specifies the address of the scheduling manager that the agent works with. This value corresponds to the IP address or hostname in the connection details for the scheduling manager. You can specify a list of addresses for the scheduling manager.

Examples: abc1.com, 172.24.36.107

Enter the manager port number:

Specifies the port that the scheduling manager listens on for communication from agents. This value corresponds to the port number in the connection details for the scheduling manager.

Limits: 1024-65534

Do you want to register another manager?

Indicates whether you want to configure the agent to work with additional scheduling managers.

■ Y—Configures the agent to work with additional scheduling managers. If you choose Y, you will be prompted for the manager ID, manager address, and manager port.

■ N—Does not configure the agent to work with additional scheduling managers.

Default: N

Note: You can also add entries to register the scheduling manager manually to the installation_volume.CAUNI.CAHOSTS file after the installation. If you update these entries, you must restart the agent for your changes to take effect. The UNICYCLE ALL command performs a shutdown immediately followed by a startup. For more information about updating this file, see the CAHOSTS file (see page 42).

Enter the name of the TCP/IP process:

Specifies the name of the TCP/IP process.

Example: $zsam1

Install the Agent


Do you want the agent to use a DNS?

Indicates whether you want to use a DNS (Domain Name Server) or a HOSTS file to resolve TCP/IP addresses and host names.

■ Y—Uses a DNS to resolve TCP/IP addresses and host names.

■ N—Uses a HOSTS file to resolve TCP/IP addresses and host names. If you choose N, you will be prompted for the fully qualified name of the HOSTS file.

Default: Y

Note: If a DNS is not supported on the HP Integrity NonStop system on which the agent is currently installed, you must update the system's HOSTS file with the corresponding IP address entries for the both local and remote systems.

Enter the local TCP/IP node name for current_system_name:

Specifies the name of the local TCP/IP node name for the current HP Integrity NonStop system.

Example: usplnsk

Do you want to change the CPU Assignments now?

Indicates whether you want to change the default CPU assignments. By default, CA WA Agent for HP Integrity NonStop assigns the primary CPU to 0 and the backup CPU to 1.

■ Y—Changes the default CPU assignment.

■ N—Does not change the default CPU assignment.

Default: N

Do you want to start CA WA Agent for HP Integrity NonStop?

Indicates whether you want to start the agent.

■ Y—Starts the agent.

■ N—Does not start the agent.

Default: N

The agent is installed.

7. Type the following command to display the status of the agent:

UNIFSTAT

The agent running status is displayed.

Reinstall the Agent


Reinstall the Agent

If you receive a new version of the agent or if the agent files are purged or get corrupted, you can reinstall the agent using the interactive program.

When you reinstall CA WA Agent for HP Integrity NonStop, the interactive program prompts you for additional information.

To reinstall CA WA Agent for HP Integrity NonStop

1. Log in as SUPER.SUPER.

2. Download the CAWAPAK installation package to the location from which the agent is to be installed. This may be a temporary local drive and not where you plan to actually install the agent.

3. Decompress the installation package using the following command:

UNPAK CAWAPAK,*.*.*,VOL volume_name

volume_name

Specifies the volume where the agent is to be installed.

4. Go to the CARELSCR subvolume. For example, type “volume volume_name.CARELSCR”.

CARELSCR is the subvolume where the files are placed after the execution.

5. Type the following command to start the installation:

RUN CASETUP

The agent installation program opens.

6. Continue with the reinstallation by entering the required information.

Depending on the current state of your system, the prompts received during installation vary. The installation program may include any of the following prompts:

Enter the volume on which you are going to install or have installed the product:

Specifies the name of the volume where you want to reinstall the agent. We generally recommend entering the same volume where you originally installed the agent unless circumstances prevent you from doing so.

Example: $c36

Reinstall the Agent


Do you want to copy the software again?

Indicates whether you want to copy the software again. This is not necessary unless some files were corrupted or deleted.

■ Y—Copies the software to the system.

■ N—Does not copy the software to the system.

Default: N

Do you want to run INSTALL now?

Indicates whether you want to complete the installation by configuring the agent.

■ Y—Completes the installation by configuring the agent.

■ N—Exits the program installation without configuring the agent. When you restart the installation program, the installation continues from this point.

Default: Y

Do you wish to reinstall this function?

Indicates whether you want to reinstall the Workload Agent function.

■ Y—Reinstalls this function.

■ N—Does not reinstall this function.

Default: Y

Is this ok?

Indicates whether you want to create a new version of the RC file.

■ Y—Create a new version of the RC file.

■ N—Does not create a new version of the RC file.

Default: Y

Example: $C36.CAUNISCR.RC

Note: The RC file contains the run commands for the various agent components. This file should not be altered in any way except under direct supervision of CA Technologies Technical Support.

Do you want to recreate these files as part of this reinstallation?

Indicates whether you want to recreate the RMTPRF and CCIPRF files (CCI parameter files) as part of this reinstallation.

■ Y—Recreates the multiple files as part of this reinstallation.

■ N—Does not recreate the multiple files as part of this reinstallation.

Default: Y

Uninstall the Agent


Do you want to replace it with new entries?

Indicates whether you want to configure the agent to work with one or more scheduling managers. The CAHOSTS file contains the scheduling manager registration.

■ Y—Configures the agent to work with one or more scheduling managers. A backup of the old CAHOSTS file is created and you are prompted to enter the scheduling manager registration.

■ N—Does not configure the agent to work with one or more scheduling managers. The CASETUP script takes the entries in the old CAHOSTS file.

Default: N

Note: For CA Workload Automation ESP Edition, you can edit the CAHOSTS file to register the scheduling managers manually. For other scheduling managers, the CAHOSTS file is updated automatically. For more information about updating this file, see the CAHOSTS file (see page 42).

The agent is reinstalled.

7. Type the following command to display the status of the agent:

UNIFSTAT

The agent running status is displayed.

Uninstall the Agent

You uninstall CA WA Agent for HP Integrity NonStop using an interactive program that prompts you for the required information.

To uninstall CA WA Agent for HP Integrity NonStop

1. Log in as SUPER.SUPER

2. Uninstall the agent using the following command:

installation_volume.CARELSCR.DEINSTAL

3. Continue with the uninstallation by entering the required information:

Do you wish to deinstall ALL the agent software?

Indicates whether you wish to uninstall all the agent software.

■ Y—Uninstalls all of the agent software.

■ N—Does not uninstall the agent software.

Default: N

Uninstall the Agent


Are you sure EVERY agent function should be deinstalled?

Indicates whether you want to uninstall every agent function.

■ Y—Uninstalls all agent function.

■ N—Does not uninstall the agent function.

Default: N

The agent is uninstalled.

Note: The CARELSCR.TACLSEGF file may not be automatically purged after uninstalling. This file remains open and cannot be purged until all currently attached TACL sessions are detached.


Chapter 3: Controlling the Agent

This section contains descriptions of some of the utilities that are available to you to control the agent.

volume_name.CARELSCR.UTILS is the source library for the Enterprise Management TACL segment file. The UTILS file contains the agent management utilities, for example, the unicycle, unistart, unishutdown, and unifstat utilities.

Note: The UTILS file should not be altered in any way except under direct supervision of CA Technologies Technical Support.


unicycle Utility—Recycles Functions and Related Services (see page 27) unistart Utility—Starts the Agent Components (see page 28) unishutdown Utility—Shuts Down Functions and Related Services (see page 28) unifstat Utility—Checks Status of the Agent Functions (see page 28) Start the Agent (see page 29) Stop the Agent (see page 29) Configure Automatic Startup (see page 29) Verify the Status of the Agent (see page 29) Display Agent Version Procedure Information (see page 30)

unicycle Utility—Recycles Functions and Related Services

The unicycle utility shuts down and restarts one or more functions. The unicycle utility is equivalent to performing a unishutdown followed by a unistart.

Note: SUPER.SUPER should issue this utility.

This utility has the following format:

unicycle ALL

Note: An important consideration when working with TCP/IP is discussed in the known issue "Customized TCP/IP Related DEFINES are Removed When the Agent Starts" in the Release Notes.

unistart Utility—Starts the Agent Components


unistart Utility—Starts the Agent Components

The unistart utility starts CA Workload Automation Agent for HP Integrity NonStop required components. The utility provides a convenient way to start one or more of the components using a single command.



unistart ALL

Note: An important consideration when working with TCP/IP is discussed in the known issue "Customized TCP/IP Related DEFINES are Removed When the Agent Starts" in the Release Notes.

unishutdown Utility—Shuts Down Functions and Related Services

The unishutdown utility systematically shuts down all the agent components. Any work in progress is typically completed before the responsible daemon is terminated.

You can use this utility to shut down one or more functions without terminating all processing.



unishutdown ALL

unifstat Utility—Checks Status of the Agent Functions

The unifstat utility displays the status of the functions, common objects, and services currently configured on the specified computer.


unifstat ALL [ DETAIL ]

DETAIL

(Optional) Provides additional information such as the process’s priority, the wait state, and the program name.

Start the Agent


Start the Agent

When installation finishes on an HP Integrity NonStop computer, issue the following utility to start all CA WA Agent for HP Integrity NonStop components:

unistart all

Stop the Agent

Issue the following utility to stop the agent on the HP Integrity NonStop platform:

unishutdown all

Configure Automatic Startup

You can automate the startup and shutdown of the CA WA Agent for HP Integrity NonStop after installing it.

To do so, on every HP Integrity NonStop computer where CA WA Agent for HP Integrity NonStop is installed, add CASTART ALL to the $SYSTEM.SYSnn.CIIN file.

Verify the Status of the Agent

Issue the following utility to verify the status of the agent on the HP Integrity NonStop platform:

unifstat

Display Agent Version Procedure Information


Display Agent Version Procedure Information

CA WA Agent for HP Integrity NonStop consists of various executable programs. Each of these programs contains release, build, and maintenance information. In addition, a program’s Binder timestamp shows the date and time when a particular program was created. AGVERRPT is a TACL routine which is delivered with the agent. This script generates an Agent Version Report that displays version-related data. When you run the script, the report is displayed on your terminal.

The AGVERRPT script resides at volume_name.CARELSCR.

To run the AGVERRPT script and display your agent’s version procedure information, enter the following command:

RUN volume_name.CARELSCR.AGVERRPT volume_name

volume_name

Specifies the volume where the agent is installed.

Example: RUN $DATA2.CARELSCR.AGVERRPT $DATA2


Chapter 4: Maintaining Spool and Log Files


Spool File Maintenance (see page 31) Agent Log File Maintenance (see page 33) Tracing (see page 35) Standard Streams (see page 35)

Spool File Maintenance

The output for workload is stored in spool files that the agent software generates. The agent creates the files pertaining to jobs that consist of spool files, job log files, output files, and error files. The creation of spool and job log files is optional, dependent on agent configuration settings, however the default is to produce both spool and job log files. The creation of output and error files is also optional, and is designated in the job request sent by the scheduling manager.

Job log files are used to analyze jobs whenever job submission fails. A scheduling manager schedule or submit the job log files that stores the information of a particular job. The contents of a job log file include an AFM message, job submission status, environment variable details, and so on. You have the option of producing job log files (JOBLOG: Y) or not producing job log files (JOBLOG: N) through the agent configuration parameters in the CAOPTS file. If the job completes successfully, you can also set the agent to automatically purge job log files (JOBLOG-AUTO-CLEANUP: Y).

Spool files and job log files are created in the installation_volume location in the format of SPmmyydd, where mmyydd is the current date. You have the option of specifying a different volume for spool files using the SPOOL-LOCATION parameter in the agent’s CAUNI.CAOPTS configuration file. The scheduling manager specifies the location of output and error files in the job request.

Spool files are limited in size by the available space on the file system where they reside. We recommend that you clear spool files and job log files regularly to maintain storage space. The agent does not clear the spool files by default; however, you can configure the agent to clear spool files automatically. The agent can be set to remove spool files either immediately after the job completes successfully or at a future date. You can also specify that your spool files be saved for a specific amount of time, such as 14 days. By default, the agent configuration does not remove the spool files. We recommend that you use one of the following methods to manage your spool files.

Spool File Maintenance


Method 1:

Suppose you want the agent to create spool and job log files for your jobs, and delete the files automatically if the jobs complete successfully. Update the CAUNI.CAOPTS file as follows:

SPOOL-AUTO-CLEANUP: Y

JOBLOG: Y

JOBLOG-AUTO-CLEANUP: Y

Method 2:

Suppose you want the agent to create spool and job log files for your jobs, but you prefer to keep the files on the system for one week before the agent delete the files. You also want the agent to check daily for spool files that have passed the seven day expiration period. Update the CAUNI.CAOPTS file as follows:

SPOOL-AUTO-CLEANUP: N

SPOOL-FILE-DELETE: Y

SPOOL-FILE-EXPIRY: 7D

SPOOL-SLEEP-TIME: 1D

JOBLOG: Y

JOBLOG-AUTO-CLEANUP: N

Method 3:

Suppose you want the agent to create spool and job log files for your jobs, but you prefer to remove the spool and job log files using a weekly scheduled batch program. Update the CAUNI.CAOPTS file as follows:

SPOOL-AUTO-CLEANUP: N

SPOOL-FILE-DELETE: N

JOBLOG: Y

JOBLOG-AUTO-CLEANUP: N

More information:

SPOOL-AUTO-CLEANUP—Automatically Deletes the Spool File (see page 48) SPOOL-FILE-DELETE—Enable or Disable Purging of Spool Files (see page 49) SPOOL-FILE-EXPIRY—Delete Spool Files Older than Specified Value (see page 49) SPOOL-SLEEP-TIME—Specify the Duration of Spool File Storage (see page 50) SPOOL-VOLUME—Location of Spool Files (see page 50) JOBLOG—Create Job Log (see page 46) JOBLOG-AUTO-CLEANUP—Job Log Automatically Cleaned (see page 47)

Agent Log File Maintenance


Spool File Retrieval

Spool file retrieval extracts spool file contents for a particular job from an agent whenever requested by a scheduling manager.

The types of data that a scheduling manager requests are as follows:

Output File

Specifies the output file name when the scheduling manager submits a job to the agent. The agent creates this output file and stores the output, if any, of the executed job.

Error File

Specifies the error file name when the scheduling manager submits a job to the agent. The agent creates this error file and uses this file to store errors, if any, while the job is being executed.

Spool File

Specifies the location of the standard output file, standard error file, or both when the scheduling manager submits a job to the agent.

If a standard output or error file is omitted in the incoming job request, the spool file itself will be treated as the standard output or error file and the job's output or error, if any, will be redirected to the spool file.

Job Log File

Specifies the job information, for example, job status, job's process ID, standard stream locations, and user ID the job is executed under.


The agent maintains a pair of logs that contain records of all messages (AFMs) sent from the scheduling manager to the agent (RECEVLOG) and from the agent to the scheduling manager (TRANSLOG). Another set of agent log files is used to store internal console messages about jobs and their statuses as they move through submission and execution on the HP Integrity NonStop system.

More information:

CAI-CONLOG—CAIOPR Log File for HP Integrity NonStop (see page 43) CAI-LOG-SUBVOL—Logs Stored in the Specified Subvolume (see page 45) LOG-ROLLOVER-TIME—Automatic Log Rollover Based on Time (see page 47) LOG-ROLLOVER-SIZE—Automatic Log Rollover Based on Size (see page 47)



AFM Logs

The agent AFM log files consist of a receive log (RECEVLOG) and a transmit log (TRANSLOG). The default location for the AFM logs is the CAAFMLOG subvolume on the installation_volume. However, you can modify the CAI-LOG-SUBVOL parameter to set an alternative location in the CAUNI.CAOPTS file.

The RECEVLOG and TRANSLOG files are open while the agent is running. The agent writes incoming and outgoing AFMs to the files as job requests are received and processed. Depending on the number of job submissions that are processed, these logs grow in size. While striving to achieve continuous processing, the agent has the ability to roll over these log files which helps to manage the disk space on your system. The agent provides two methods to determine when the AFM logs roll over; one based on file size and the other based on a specified time of day.

By default, the agent is configured to have the AFM logs roll over when their size reaches 95,300 KB. You can modify the LOG-ROLLOVER-SIZE parameter to specify another size limitation in the CAUNI.CAOPTS file.

Alternately, you can configure the AFM logs to roll over at a specific time every day. You can remove the LOG-ROLLOVER-SIZE parameter and can add the LOG-ROLLOVER-TIME parameter with the time of day for the logs to roll over in the CAUNI.CAOPTS file.

When a log is rolled over, it is moved into the ARCHLOG subvolume that is on the agent installation_volume. The agent does not purge AFM logs that roll over into the installation_volume.ARCHLOG subvolume. Therefore, you must clean up the ARCHLOG subvolume.

Console Logs

The agent maintains a set of four daily console logs. The agent uses these logs to store the internal information about jobs being processed. Each day a new set of four console logs are created. The default location for the console logs is installation_volume.CAOPRLOG. However, you can specify a different location for the console logs using the CAI-CONLOG parameter in the CAUNI.CAOPTS file.

While the agent automatically rolls over the console logs daily, there is no automated method within the agent for deleting old logs. Therefore, the logs must be removed manually. However, a TACL macro CAOPRSCR.CLEANUP is provided to assist with regular console log removal. To run the CAOPRSCR.CLEANUP TACL macro, specify any of the following arguments:

■ mm/dd/yyyy—Deletes any console log files older than the date specified

■ YESTERDAY—Deletes any console log files older than yesterday

■ WEEKLY—Deletes any console log files older than seven days

Tracing


EMS Logs

All agent errors and warnings are forwarded to the NonStop Event Management System (EMS), which can be retrieved from EMS logs and viewed using standard EMS methods. EMS logs are maintained at the system administration level and are not a function of agent log maintenance.

Tracing

Tracing records function-level details of processes, which can be used to find and fix errors if agent-manager communication fails or is abnormal.

Tracing is disabled by default. To diagnose a problem, you may be asked to enable tracing using the CAI-CCI-DEBUG and CAI-TRACE-SUBVOL parameters. We strongly recommend that you do not modify these parameters except under direct supervision of CA Technologies Technical Support.

Important! When tracing is enabled, the log files could consume large amount of disk space. This impacts the system and the agent performance. Ensure that you disable tracing after you complete troubleshooting.

Standard Streams

The standard streams are pre-connected input and output channels between an application and its environment that exchange data when the application is running.

The following are the I/O connections:

■ STDIN (Standard input)

■ STDOUT (Standard output)

■ STDERR (Standard error)

These streams have the following syntax:

$volume.sub_volume.filename

Notes:

■ The entire value can be up to 26 characters. Each field can be up to eight characters.

■ CA WA Agent for HP Integrity NonStop does not support the STDIN and STDERR redirection files for the TACL macros or commands in the incoming AFM.


Chapter 5: Configure Additional Options

This chapter contains information about configuring the agent’s behavior and communication in your environment post-installation. All of the configuration information in this chapter is optional; no additional configuration is required to make your agent run properly after you have installed it.


Configure Communications (see page 37) Configuration Files (see page 38) Environment Variables—User Configurable (see page 43) Environment Variables—Expert Configurable (see page 51)

Configure Communications

After agent installation, you can add communication to additional CA Workload Automation ESP Edition scheduling managers or correct errors in your original communication configuration.

To configure communications

1. Ping the scheduling manager node.

Attempt to PING the scheduling manager node. If you cannot, modify the TCP/IP setup on the HP Integrity NonStop computer and on the scheduling manager computer.

This requires a DNS entry or an entry in the HP Integrity NonStop computer's $SYSTEM.ZTCPIP.HOSTS file for the server where the scheduling manager is installed.

2. (Optional) Update the CAHOSTS file as necessary (see page 42).

A CAHOSTS file is created depending on which scheduling manager is selected. This file is updated automatically for CA Workload Automation AE and a separate file is created for CA Workload Automation ESP Edition and CA Workload Automation CA 7 Edition.

CAHOSTS is an EDIT File that stores the manager ID, manager address, and manager port. The HOST-FILE-LOCATION parameter in the agent configuration file CAOPTS indicates the present location of the created file. If this parameter is not present in the configuration file, the file is created in the location of CAOPTS – Options configuration file.

Configuration Files


This file has the following format:

mgr_id=manager_id

mgr_addr=manager_address

mgr_port=manager_port

3. Determine the status of the remote server.

The remote server must be running. To determine whether it is running, issue the unifstat command.

A series of messages appears indicating the status of servers. If the remote server is running, the following message appears:

CCI Remote Server nnn running

nnn

Specifies the process ID of the Remote Server process.

4. Start the HP Integrity NonStop agent.

If you modify the agent options or determine that not all of the agent is running when the unifstat command is issued, you must stop and restart the agent.

To stop and restart the agent, log in as SUPER.SUPER and run the following command:

unicycle all

Configuration Files

This section describes the various configuration files available on the HP Integrity NonStop platform.

Notes:

■ If you update these files, you must restart the agent for your changes to take effect.

■ Some of these files refer to CAICCI, which is a CA Technologies communication protocol that handles cross-platform and Event Management-related communications.

CACCICFG.CCIPRF File

The CACCICFG.CCIPRF file tells the main CAICCI daemons running on HP Integrity NonStop what to do and specifies the Max_Recvrs value.

Note: The Max_Recvrs value in the CACCICFG.CCIPRF file should not be altered in any way except under direct supervision of CA Technologies Technical Support.

Configuration Files


Path Name

installation_volume.CACCICFG.CCIPRF

SERVICES File

You can modify the agent's port number in the SERVICES file of the HP Integrity NonStop system.

Note: If the port option is not specified, the port number of the agent is 1721 by default.

Example: Specify the Port

This example instructs the agent to start listening at the specified port number, 7015. The SERVICES file has the following entry:

caicci 7015/tcp

CAUNI.CAOPTS File

The CAUNI.CAOPTS file is created automatically during installation and contains various environment variables. These environment variables can be classified as either user-configurable or expert-configurable.

The user-configurable environment variables are as follows:

■ CAISCHD0006

■ CAISCHD0008

■ CAISCHD0010

■ CAI-CCI-DEBUG

■ CAI-CONLOG

■ CAI-DATEFMT

■ CAI-LOG-SUBVOL

■ CAI-OPR-CONFIG

■ CAI-TRACE-SUBVOL

■ JOBLOG

■ JOBLOG-AUTO-CLEANUP

■ HOST-FILE-LOCATION

Configuration Files


■ LOG-ROLLOVER-TIME

■ LOG-ROLLOVER-SIZE

■ SPOOL-AUTO-CLEANUP

■ SPOOL-FILE-DELETE

■ SPOOL-FILE-EXPIRY

■ SPOOL-SLEEP-TIME

■ SPOOL-VOLUME

■ TCPIP-PROCESS-NAME

■ WLA-AGENT-NAME

■ WLA-PASSW-REQUIRED

The expert-configurable environment variables are as follows:

■ CACONSOLE

■ CAOPR-EMS

■ CAOPR-EMS-NAME

■ CAIGLBL0000

■ CAIMESSAGE

■ CAISCHD0001

■ CAISCHD0002

■ CAISCHD0030

■ CA-OPERA-NODE

■ CAI-CAMSGF-OPRDIRECT

■ CAI-EXE

■ CAI-LOCAL-NODE

■ CAI-MSGREADER

■ CAI-TCPIP-HOSTNAME

■ EXECUTABLES-VOLUME

■ TCPIP-HOST-FILE

Note: The expert-configurable environment variables should only be modified under the direction of CA Technologies Technical Support. They are described separately in the appendix.

Configuration Files


More information:

Environment Variables—Expert Configurable (see page 51) Environment Variables—User Configurable (see page 43)

Display Environment Variables

To display all environment variables, enter the following command from a TACL prompt:

CAOPT *

To display a single environment variable, enter the following command from a TACL prompt:

CAOPT environment_variable

Change Environment Variables

To change the value of an environment variable, enter the following command from a TACL prompt:

CAOPT environment_variable new_value

Note: Consult with CA Technologies Technical Support before changing the value of an expert-configurable environment variable.

Path Name

$installation_volume.CAUNI

CAUNI.MOMOPTS File

The CA persistence monitor, $CAMOM, monitors the CAUNI.MOMOPTS file and identifies components and processes. The $CAMOM monitor program pulls the process names from the MOMOPTS file to determine which components to monitor.

$CAMOM provides a level of fault tolerance by monitoring the status of processes within a component. If a monitored process fails or stops unexpectedly, $CAMOM issues the appropriate command to restart the process.

Configuration Files


For each component, there are two types of entries, a component description followed by associated process descriptions. The following is the format of either type of entry:

ID TYPE NAME

Component Entry

ID

Specifies a three-character component identifier such as WLA or OPR.

TYPE

Specifies either PREREQ or COMPONENT. A PREREQ is checked for status and started whenever any COMPONENT is started.

NAME

Specifies the name of the macro file used to start the component.

Process Entry

ID

Specifies a three-character component identifier that must match an associated component description.

TYPE

Specifies either EXEC or NAME.

NAME

Specifies either the name of the associated executable or the process name, depending on which type is being described.

All file names are qualified with the name of the volume where Workload Monitor is installed. A component is monitored only if a file named INSTLOG resides in the same subvolume as the startup macro for the component. If the listed executable file does not exist, a process of type EXEC is not monitored .

APPEND or DEPEND qualifies the TYPE entry for a process. In this case, the process is monitored only if the process defined immediately before it is not being monitored.

Path Name


CAHOSTS File

CAHOSTS is a new file used to register scheduling manager entries based on their ID, name, and port information. This file will be created during the agent installation. You can enter or register the manager details interactively.

Environment Variables—User Configurable


Path Name



This section describes the CA Workload Automation Agent for HP Integrity NonStop user-configurable environment variables.

The user-configurable environment variables explain agent behavior. You are prompted for many of these environment variables during installation. You may change the values during the installation or after the installation, if required. They are listed here in alphabetical order.

CAI-CCI-DEBUG—Enable or Disable Tracing

The CAI-CCI-DEBUG variable lets you enable or disable tracing.

This variable has the following format:

CAI-CCI-DEBUG: Y | N

Y

Lets you enable tracing.

N

Lets you disable tracing.

Default: N

CAI-CONLOG—CAIOPR Log File for HP Integrity NonStop

The CAI-CONLOG variable specifies the volume and subvolume where the CAIOPR daemon writes its log files. Two files are created each day:

■ o0yymmdd—corresponds to the Console log for the specified day

■ x0yymmdd—corresponds to the Index for held and WTOR messages in the console log

Note: Both of the files contain binary data and any HP Integrity NonStop are not intended to browse.

Default: installation_volume.CAOPRLOG



CAI-DATEFMT—Date Format

The CAI-DATEFMT variable indicates the date format to use. CA Workload Automation Agent for HP Integrity NonStop prefers a date format that comprised of a day (dd or ddd), a month (mm or mmm) and a year (yy or yyyy).

You can arrange the date elements in any order, but can use each element only once.

Default: mm/dd/yyyy

We recommend that you to use the same date format for all systems, so that they are consistent, preferably, the default date format is used on your HP Integrity NonStop system. A description of each date element follows.

dd

Specifies a day of the month, from 01 to 31.

The range of days in January is 01 to 31. The range of days in February is 01 to 28, except during a leap year when the range is 01 to 29.

ddd

Specifies a Julian day, from 001 to 366.

mm

Specifies a numeric month, from 01 to 12.

mmm

Specifies a non-numeric month.

Valid specifications are: JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, and DEC.

yy

Specifies a valid year, from 00 to 99.

Any year in the range 00 to 59 is translated internally as a 21century date (2000-2059). Any year in the range 60 to 99 is translated internally as a 20 century date (1960-1999).

yyyy

Specifies a valid year, from 1960 to 2099.

Note: The valid date range is January 1, 1960 (01-JAN-1960) through December 31, 2099 (31-DEC-2099). A separator character must separate the date elements. Valid separator characters are: hyphen (-), period (.), slash (/), comma (,), or space ( ).

Limits: Up to 12 alphanumeric bytes



CAI-LOG-SUBVOL—Logs Stored in the Specified Subvolume

The CAI-LOG-SUBVOL variable specifies the subvolume where the transmitter and receiver logs are stored.


CAI-LOG-SUBVOL: subvolume_name

Default: CAAFMLOG

CAI-OPR-CONFIG—CAIOPR File

The CAI-OPR-CONFIG variable specifies the volume.subvolume where the CAIOPR process writes to a file, which prevents concurrent execution of multiple copies of the CAIOPR process.

Default: installation_volume.CAOPRCFG

CAISCHD0006— CA WA Agent for HP Integrity NonStop Log Files

The CAISCHD0006 variable specifies the volume where the agent command server writes log files.

Default: installation_volume

CAISCHD0008— CA WA Agent for HP Integrity NonStop Temporary Files

The CAISCHD0008 variable specifies the path name of the directory where the agent can write temporary work files.

Note: The file system of the specified directory locally mounts on the host where the agent is running.

Default: installation_volume.CAWLACFG

CAISCHD0010—Size of Workload Log File

The CAISCHD0010 variable identifies the number of records in the CAWLACFG.CACKP20 log file. When the log file fills up, entries in the file start to wrap.

Default: 1000



CAI-TRACE-SUBVOL—Traces the Files Stored in Subvolume

The CAI-TRACE-SUBVOL variable traces the files that are stored in this subvolume.


CAI-TRACE-SUBVOL: subvolume_name

Default: CATRACE

HOST-FILE-LOCATION—CAHOSTS File Location

The HOST-FILE-LOCATION variable specifies the location of the CAHOSTS file that is created.


HOST-FILE-LOCATION: $DATA1.CAUNI

It has a fixed location.

Default: None

JOBLOG—Create Job Log

The JOBLOG variable indicates whether the agent creates a job log for every job that runs on the system it manages.


JOBLOG: Y | N

Y

The agent creates a job log for every job that runs on the system it manages.

N

The agent does not create a job log for every job that runs on the system it manages.

Default: Y



JOBLOG-AUTO-CLEANUP—Job Log Automatically Cleaned

The JOBLOG-AUTO-CLEANUP variable indicates whether the agent automatically deletes the job log file, if the job is executed successfully.


JOBLOG-AUTO-CLEANUP: Y | N

Y

The agent automatically deletes the job log file for every job that runs on the system it manages.

N

The agent does not automatically delete the job log file for every job that runs on the system it manages.

Default: N

LOG-ROLLOVER-TIME—Automatic Log Rollover Based on Time

The LOG-ROLLOVER-TIME variable specifies the automatic log rollover based on time.

Default: Disable

Example: LOG-ROLLOVER-TIME: 2200 (sets the recurring time to 10PM every day)

LOG-ROLLOVER-SIZE—Automatic Log Rollover Based on Size

The LOG-ROLLOVER-SIZE variable specifies the automatic log rollover based on size in KB.

Default: 95300KB

Example: LOG-ROLLOVER-SIZE: 2500 (sets the file size to 2500KB)



RESP-RETRY-INTERVAL—Sets Minimum Time for Response Retries

The RESP-RETRY-INTERVAL variable sets the minimum amount of time the agent waits before attempting to contact the scheduling manager after repeated attempts fail.


RESP-RETRY-INTERVAL: minutes

minutes

The number of minutes to wait before resending attempts that the agent previously failed.

Default: 2 minutes

SPOOL-AUTO-CLEANUP—Automatically Deletes the Spool File

The SPOOL-AUTO-CLEANUP variable indicates whether the agent automatically deletes the spool file if the job is executed successfully.


SPOOL-AUTO-CLEANUP: Y | N

Y

The agent automatically deletes the spool file for every job that runs on the system it manages.

N

The agent does not automatically delete the spool file for every job that runs on the system it manages.

Default: N



SPOOL-FILE-DELETE—Enable or Disable Purging of Spool Files

The SPOOL-FILE-DELETE variable enables or disables the purging of spool files.


SPOOL-FILE-DELETE: Y | N

Y

Enables the purging of spool files.

N

Disables the purging of spool files.

Default: N

SPOOL-FILE-EXPIRY—Delete Spool Files Older than Specified Value

The SPOOL-FILE-EXPIRY variable specifies how long the agent retains spool files. Files older than the specified value are deleted.


SPOOL-FILE-EXPIRY: nD|H|M

n

Specifies the number of days, hours, or minutes.

D

Indicates that the value is in days.

H

Indicates that the value is in hours.

M

Indicates that the value is in minutes.

Default: 10D

Notes:

■ The value of n must be an integer.

■ The agent will not take a combination of time periods, for example, 5D 10H. If an invalid value is entered, the agent uses the default value.



SPOOL-SLEEP-TIME—Specify the Duration of Spool File Storage

The SPOOL-SLEEP-TIME variable specifies the duration when the agent checks the spool files that meet the specified expiration time.


SPOOL-SLEEP-TIME: nD|H|M

n

Specifies the number of days, hours, or minutes.

D

Indicates that the value is in days.

H

Indicates that the value is in hours.

M

Indicates that the value is in minutes.

Default: 1D

Notes:

■ The value of n must be an integer.

■ If the SPOOL-SLEEP-TIME value exceeds the SPOOL-FILE-EXPIRY value, the agent ignores the SPOOL-SLEEP-TIME variable.

■ The agent will not take a combination of time periods, for example, 5D 10H. If an invalid value is entered, the agent uses the default value.

SPOOL-VOLUME—Location of Spool Files

The SPOOL-VOLUME variable specifies the volume where the spool files are stored.


SPOOL-VOLUME: volume_name

Default: None

TCPIP-PROCESS-NAME—Specify the User Response to the Prompt

The TCPIP-PROCESS-NAME variable specifies the user’s response to the “Enter the TCPIP process name:” prompt during the agent installation. This value can be changed after the initial installation.

Environment Variables—Expert Configurable


WLA-AGENT-NAME—Name of the Agent

The WLA-AGENT-NAME variable specifies the name of the agent. You can specify the agent's name while installing the agent. The agent name can also be configured manually in the CAOPTS file. If you intend to install multiple instances of CA WA Agent for HP Integrity NonStop, provide a unique name for each instance.

Example: WLA-AGENT-NAME: PROAGENT

WLA-PASSW-REQUIRED—Password Required

The WLA-PASSW-REQUIRED variable specifies whether the agent has permissions to set the proper user ID jobs are run under.


WLA-PASSW-REQUIRED: Y | N

Y

The agent validates the user password before submitting the job. The job fails if the password is incorrect.

N

The agent does not validate the user password before submitting the job.

Default: Y

Note: You must set the WLA-PASSW-REQUIRED environment variable to N when working with CA Workload Automation AE for spool file retrieval to work properly.


This appendix describes the CA Workload Automation Agent for HP Integrity NonStop expert-configurable environment variables. These environment variables should not be altered in any way except under direct supervision of CA Technologies Technical Support.

The expert-configurable environment variables explain system behavior. You are prompted for many of these environment variables during installation. They are listed here in alphabetical order.



CACONSOLE—Virtual Home Terminal for HP Integrity NonStop Processes

The CACONSOLE variable specifies the process name of the virtual home terminal for the agent processes.

Default: $CACON

CAI-CAMSGF-OPRDIRECT—Messages to EMS Log

The CAI-CAMSGF-OPRDIRECT variable controls whether output from the CA Workload Automation Agent for HP Integrity NonStop component Workload Monitor is logged to the EMS log, or directly to the console daemon. If this variable exists, output goes directly to the console daemon by default.

CAI-EXE—Executable Volume and Subvolume

The CAI-EXE variable identifies where the agent executable volume.subvolume is located. This variable typically has the same value as CAIGLBL0000.

Default: installation_volume.CAUNIEXE

CAIGLBL0000—CA WA Agent for HP Integrity NonStop Installation Volume

The CAIGLBL0000 variable specifies the path where the agent is installed.

Default: installation_volume.CAUNIEXE

CAI-LOCAL-NODE—Installation Expand Name

The CAI-LOCAL-NODE specifies the expanded name of the system the agent is installed on.

Default: HP Integrity NonStop system name

CAIMESSAGE—HP Integrity NonStop Message File

The CAIMESSAGE variable defines the volume.subvolume of the HP Integrity NonStop message file for the agent.

Default: installation_volume.CAMSGAME



CAI-MSGREADER—Message Router

The CAI-MSGREADER variable specifies the process name of the message router.

Default: $CACON

CAISCHD0001—Workload Management Executables

The CAISCHD0001 variable specifies the path name for the agent's executables and scripts (not to be confused with the scripts the agent submits on behalf of other users).

Default: installation_volume.CASCHEXE

CAISCHD0002—Metacharacters in JOBPARM Statement

The CAISCHD0002 variable controls how the agent submits commands for execution. If the following conditions are met, the agent attempts to submit the command directly to a PROCESS_CREATE call:

■ CAISCHD0002 is set to E.

■ The command represents a file with a file code of 100.

■ No forward slash (/) characters in the command indicating run options.

If any of these conditions are not met, the command is submitted to a TACL process.

CAISCHD0030—Previous Version Compatibility

The CAISCHD0030 variable is required for compatibility with other scheduling manager types. For this implementation, this variable must be present and set to 20.

CAI-TCPIP-HOSTNAME—Installation Host Name

The CAI-TCPIP-HOSTNAME variable specifies the host name (not the node name or the expand name) of the HP Integrity NonStop system the agent is installed on.

Default: None



CA-OPERA-NODE—Console Daemon Node

The CA-OPERA-NODE variable indicates the machine (node) where the Event Management service provider (CAIOPR) resides.

Limits: Up to 64 alphanumeric characters

Default: assigned during installation

CAOPR-EMS—EMS Distributor Parameters

The CAOPR-EMS variable specifies parameters for starting an EMS distributor.

Default: Type F, collector $0, filter $installation_volume.CAUNIEXE.CAFILALL, target

CAOPR-EMS-NAME—EMS Distributor Process Name

The CAOPR-EMS-NAME variable specifies the process name of the EMS distributor.

Default: $CAEMS

EXECUTABLES-VOLUME—Location of Executables

The EXECUTABLES-VOLUME variable identifies the volume (disk pack) where the agent executables are located.

Default: installation_volume

TCPIP-HOST-FILE—Host File Used by CAICCI

The TCPIP-HOST-FILE variable specifies the name of the hosts file that CAICCI uses when a DNS is not used.

Default: None

Index 55

Index

A

agent communication with a scheduling manager • 11 controlling • 27 description • 9 displaying agent version procedure information •

30 enabling in your environment • 15 log file maintenance • 33 security • 12 spool file maintenance • 31 uninstall process • 25 updates • 16

agent files job files • 17 log files • 17, 33 spool files • 17, 31, 33

C

CAICCI • 38 CAOPRSCR.CLEANUP macro • 34 communication • 11 configuration files

CACCICFG.CCIPRF file • 38 CAHOSTS file • 42 CAUNI.CAOPTS file • 39 CAUNI.MOMOPTS file • 41 SERVICES file • 39

configure communications • 37 controlling the agent

configuring automatic startup • 29 starting • 29 stopping • 29 verifying the status • 29

D

displaying agent version procedure information • 30

E

environment variables expert environment variables • 51 user environment variables • 43

expert environment variables CACONSOLE • 52

CAI-CAMSGF-OPRDIRECT • 52 CAI-EXE • 52 CAIGLBL0000 • 52 CAI-LOCAL-NODE • 52 CAIMESSAGE • 52 CAI-MSGREADER • 53 CAISCHD0001 • 53 CAISCHD0002 • 53 CAISCHD0030 • 53 CAI-TCPIP-HOSTNAME • 53 CA-OPERA-NODE • 54 CAOPR-EMS • 54 CAOPR-EMS-NAME • 54 EXECUTABLES-VOLUME • 54 TCPIP-HOST-FILE • 54

I

installation considerations • 16 process • 18 reinstalling • 23 uninstalling • 25

J

job types, supported • 10

L

local security, setting up • 12 logs

AFM logs • 34 console logs • 34 EMS logs • 35

S

scheduling manager supporting • 13

spool file maintenance • 31 standard streams • 35

T

tracing • 35

U

user environment variables


CAI-CCI-DEBUG • 43 CAI-CONLOG • 43 CAI-DATEFMT • 44 CAI-LOG-SUBVOL • 45 CAI-OPR-CONFIG • 45 CAISCHD0006 • 45 CAISCHD0008 • 45 CAISCHD0010 • 45 CAI-TRACE-SUBVOL • 46 HOST-FILE-LOCATION • 46 JOBLOG • 46 JOBLOG-AUTO-CLEANUP • 47 LOG-ROLLOVER-SIZE • 47 LOG-ROLLOVER-TIME • 47 SPOOL-AUTO-CLEANUP • 48 SPOOL-FILE-DELETE • 49 SPOOL-FILE-EXPIRY • 49 SPOOL-SLEEP-TIME • 50 SPOOL-VOLUME • 50 TCPIP-PROCESS-NAME • 50 WLA-AGENT-NAME • 51 WLA-PASSW-REQUIRED • 51

utilities unicycle utility • 27 unifstat utility • 28 unishutdown utility • 28 unistart utility • 28

ca workload automation agent for hp integrity nonstop workload...unifstat utility—checks status of...

Documents