/AGENT Command

The /AGENT command sends a request to a system agent to perform a specific control action on that agent or to update an agent configuration setting. You can request the following functions:

Refresh the agent security files.
Clear log files.
Stop the agent after current work is complete.
Update a configuration setting.
Verify the communication link to the agent.

This command has the following formats:

Format 1

/AGENT,AGENT=agent,FUNC=function

Format 2

/AGENT,AGENT=agent,PROP=name=value[,PERSIST={NO|YES}]

AGENT

Specifies the system agent that is the target of the command.

Limits: 1 to 16 alphanumeric characters

FUNC

Specifies an action that the agent is to perform.

Note: For HP NonStop agents, only FUNC=PING is supported. FUNC=SHUTDOWN gives a function complete message but has no actual impact on the agent. All other FUNC and PROP values are returned with the message AFM2-009 Timed out waiting on response.

The following values are valid:

CLRFILES

Clears agent log files.

PING

Verifies the communication link to the agent. The return of a RESPONSE STATUS message indicates success. The return of AFM2-009 Timeout message indicates failure.

REFRESH

Refreshes the agent security files.

SHUTDOWN

Stops the agent.

Note: The agent sometimes does not send a response in a timely manner to indicate that the agent is shut down. You can verify the shutdown using the LAGENT command or by locating the physical computer on which the agent executes.

PROP

Specifies a system agent configuration setting for an update. The format is name=value where name is the configuration property to change and value is the new setting.

PERSIST

(Optional) Specifies whether the configuration setting changed with the PROP keyword is a permanent change or the change is in effect for the current session only. The following values are valid:

NO: Specifies that the configuration change is for current session only. NO is the default.
YES: Specifies that the configuration change is permanent.