Using the Command Line Utilities › hdbgctrl Command-Debug Control

hdbgctrl Command-Debug Control

The broker –qtrace option, the hserver –logging option, and the remote agent –trlvl option can be turned on or off at runtime by using the hdbgctrl debug control utility. This utility is an administration tool, so the user must have the CA Harvest SCM administrator privileges to run this command. The trace messages are written to the default process log file.

This command has the following format:

hdbgctrl [-b name] [-rm name -rport portnumber] [-usr username] [-pw password] [-prompt] [-eh filename] [-o filename | -oa filename] [-h] debug_control_string

-b name

(Required, must specify –b or -rm) Specifies the CA Harvest SCM broker name. This option is required if the target process is the broker or the hserver.

-rm name

(Required, must specify –b or -rm) Specifies the remote agent computer name. This option is required if the target process is the agent.

-rport portnumber

(Required, must specify –b or -rm) Specifies the port number of the remote agent computer. This option is required if the agent computer name is specified.

-usr username

(Required, unless -prompt is specified) Specifies the user name for login to the broker or agent. If -usr is defined without -pw, the user is prompted for the password at runtime.

-pw password

(Required, unless -prompt is specified) Specifies the password for login to the broker or agent. To hide the password from being exposed in plain text on the command line, use the prompt option.

-eh filename

(Optional) Specifies the encrypted CA Harvest SCM or agent username-password file name. The file name used with this option contains encrypted username-password credentials and must be generated with the svrenc utility.

Note: -eh overrides -usr and -pw options. -prompt overrides -eh, -usr and -pw options.

Debug_control_string

Controls the trace options for the broker, the hserver, and the remote agent. The string has the following format:

process_name:switch:logging_level:transaction_name:client_host

process_name:broker, hserver, or agent

Specifies which process is controlled. This field is required for all target processes.

switch: on or off

Specifies enable (on) or disable (off) the trace for the target process. This field is required for all target processes.

logging_level: 1-5 for hserver, 1-3 for agent

Specifies the level of the trace (-logging for hserver and –trlvl for the agent) for the target process. This field is required if the target process is the hserver or the agent and the switch is on. This field is ignored if the target process is the broker or the switch is off.

transaction_name: hserver transaction name or “all” for all transaction types

Specifies which transaction the hserver trace is activated. The trace is turned off automatically at the end of the transaction. This field is required for the hserver. The field is ignored for the broker and the agent. Only one transaction type can be activated for debug trace at any time unless “all” is specified for the transaction_name.

client_host: client_machine_name

Activates the hserver trace only if the transaction request is from the specified client and the transaction matches the specified transaction name. This field is optional for the hserver and is ignored if the target process is the broker or the agent.

Examples: hdbgctrl Command

hdbgctrl -b scmbroker -usr scmuser -pw passwd broker:on
hdbgctrl -b scmbroker -usr scmuser -pw passwd broker:off
hdbgctrl -b scmbroker -usr scmuser -pw passwd hserver:on:4: LIST_VERSION_IN_VIEW
hdbgctrl -b scmbroker -usr scmuser -pw passwd hserver:on:4: LIST_VERSION_IN_VIEW:machine_A
hdbgctrl -b scmbroker -usr scmuser -pw passwd hserver:off:4: LIST_VERSION_IN_VIEW
hdbgctrl -rport portnumber -rm scmagent -usr scm agent username -pw scm agent password agent:on:1
hdbgctrl -rport portnumber -rm scmagent -usr scm agent username -pw scm agent password agent:off:1