Previous Topic: Agent Start Options (Windows)Next Topic: The USS User ID


z/OS Agent Start Options

When the z/OS agent is started with the homedir argument and the value of homedir is the high-level qualifier (HLQ) of the Hagent argument file, the z/OS agent uses MVS data sets for the agent log file and the agent argument file. The agent argument file must exist with the following name: [assign the value for hlq in your book].HAGENT.ARG, where [assign the value for hlq in your book] is the high-level qualifier specified for the homedir argument. A sequential file will be allocated for the log file with the following name: [assign the value for hlq in your book].L1yymmdd.HAGENT, where [assign the value for hlq in your book] is the high-level qualifier specified on the homedir argument, yymmdd is the two digit year, month, and day, respectively.

The HAgent.arg file is a sequential file located under the $CA_SCM_HOME folder. By default, this file contains the name of the broker specified when the agent was installed, this name is specified by the -rtserver flag.

The following information summaries the z/OS agent start options. The options are available for both the multi-user agent and the single-user agent.

Important! The option names for agntd are case-sensitive; therefore, verify that you enter these settings carefully and correctly.

-help

Displays this message to SYSPRINT.

-cm=[i , a]

Specifies the preferred connect method (to accept or initiate) to create the direct connections between the product server, client, and agent.

i initiates connection

a accepts connection

-usr

Specifies the system login name.

-pwd

Specifies the password for the system login name.

-homedir=SCM home dir

Specifies the agent location. This location must have /log subdirectory. To allocate MVS data sets for the argument and log files, specify the high-level qualifier of the agent argument file.

-port=portnumber

Specifies the port number that the agent listens to.

-timeout=int

Specifies the agent idle timeout in minutes. When the idle timeout is reached, the agent shuts down (single-user mode only).

-lockdir=lock directory

Specifies that agntd only has access to this directory and its subdirectories.

Note: Relative lock directories (for example, ../../user01/caSCM) cannot be specified. If the product detects a relative -lockdir specification, the file agent will not start.

-pwdmethod=string

Allows users to use one of two methods, “prompt” or “random,” for establishing the single-user agent password.
If -pwdmethod=prompt, the default method, the agent will prompt the user at start up to enter a password.
If -pwdmethod=random, the agent will display the randomly generated password that must be used to log in to the agent.

-shutdown

Terminates the specified agent on the local computer.

Note: The product agent shutdown can be controlled by the product broker shutdown. The broker shutdown option, -shutdown=all, shuts down all product agent processes that are visible in the RTserver network.

-enforcepatchversion=flag

Enforces the client and agent to be at the same patch level. "0" means that the client can log in to an agent at a different patch level. "1" means that the client cannot log in to an agent that is at a different patch level.

The default option setting is "0".

Note: Clients and agents at different patch levels may not operate correctly. It is recommended that your product client and agent installations have the same patch level.

‑enforcepatchversionmsg=customized error message for enforcepatchversion

Appends a customized message to the standard error message when "‑enforcepatchversion=1" is specified in the HServer.arg file.

-enforcehiddenpswd =flag

To enforce hiding of passwords from command-line utilities.

"0" means that hiding of passwords from command-line utilities is not enforced. "1" means that hiding of passwords from command-line utilities is enforced.

The default option setting is "0".

Note: On the startup of the product server or file agent process, if the enforcement of hiding of passwords on command lines is not turned on, a message will be printed to the product server or file agent log that this enforcement is disabled.

-enforcehiddenpswdmsg=customized error message for enforcehiddenpswd

A customized message that is appended to the standard error message when enforcing the hiding of passwords from command-line utilities.

-trlvl=int

Specifies a trace mode or no trace. The value of int must be 0, 1, 2, or 3. If an int value is not specified or if you specify a value not in the range, the trace turns off automatically. Each trlvl mode is distinct and does not include information from other trace modes.

0 specifies no trace.

1 traces direct connect creation, thread creation, and login operations.

2 traces file input/output operations and only displays if a function related to file input/output fails.

3 traces the invocation of hexecp.

-trace

Display PEC-related trace messages.

More information:

The Agent Trace Facility