Previous Topic: Start a Multi-User Agent (Windows)Next Topic: z/OS Agent Start Options


Agent Start Options (Windows)

The following CA Harvest SCM agent start options are available for both the multi-user agent and the single-user agent. You can specify the agent start options in the HAgent.arg file located in the %CA_SCM_HOME% directory or from the command line. If the –port option is not specified (either on the command line or in the HAgent.arg file), the agent fails to start. The multi-user agent creates a log file named YyyymmddHAgentPID_UserName_PortNumber.log in the %CA_SCM_HOME%\log directory.

The agntd command has the following format:

agntd [options]

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

Example: Start a multi-user agent

agntd -port=5000
-port

Specifies the port that the agent listens to.

Note: For those options that require you to specify a file location, the Universal Naming Convention (UNC) is not supported for specifying client paths. Instead of entering the UNC location \\server\share\directory\file, you must enter drive:\directory\file.

The following agent options are available for both the multi-user agent and the single-user agent.

-help

Displays the help file.

-verbose

Prints a log message on the window.

-homedir=SCM home dir

Specifies the agent location. This location must have /log subdirectory.

-port=portnumber

Specifies the port number that the agent listens to.

-cmfile=command file

Parses a PEC command file.

-cm=[i , a]

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

i initiates connection

a accepts connection

-install[=parent service]

Installs the program in Windows service database. A single-user file agent cannot be run as a service on Windows.

-remove

Removes the program from Windows service database.

-usr

Specifies your system login name (single-user mode only).

-pwd

Specifies your password (single-user mode only).

-eh

Specifies the dfo filename that contains the encrypted single user agent username and password (single-user mode only). You must create the dfo file using the svrenc command with the –f option. For more information about the svrenc command, see the Command Line Reference Guide.

Note: The -eh option is mutually exclusive with the -usr option.

-shutdown

Terminates the specified agent on the local computer.

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

-lockdir=lock directory

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

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

-timeout=int

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

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

-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 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 HAgent.arg file.

-enforcehiddenpswd =flag

Enforces 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 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 server or file agent log that this enforcement is disabled.

-enforcehiddenpswdmsg=customized error message for enforcehiddenpswd

Appends a customized message 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