adminagentcheck (check Administration Agent activation)

Format

To check the activation status of Administration Agent at another host:

adminagentcheck [-t timeout-value] [host-name[:port-number]]

To check the activation status of the Administration Agent at the local host:

adminagentcheck [-t timeout-value]

To Page Top

Function

This command checks whether an Administration Agent is active without going through Management Server.

To Page Top

Arguments

-t timeout-value

Specifies the amount of elapsed time (in seconds) until a timeout occurs when connecting to the Administration Agent, as an integer in the range 0 to 2147483. When 0 is specified, there is no timeout value, so the system waits until either a connection is established or an error occurs. If this option is omitted, the timeout value is set to 5 seconds.

host-name

For establishing communication with the Administration Agent, specifies either its IP address in dot notation (xxx.xxx.xxx.xxx) or a host name that can be resolved. Specify each xxx as an integer in the range 0 to 255.

port-number

Specifies the port number to be used for communication with the Administration Agent, as an integer in the range 1 to 65535.

When the -t option is omitted, the values set in adminagent.properties are used, provided that default values have been specified. When no values are specified here or a value that cannot be specified as a port number is specified, the default values are used. The table below shows the property names in adminagent.properties and the default values that are used when this option is omitted.

To Page Top

Return values

0:

The Administration Agent is running.

1:

A command execution error occurred.

When the address for the specified host name cannot be resolved, 1 is returned.

2:

A command syntax error occurred.

103:

The Administration Agent is not running.

103 is returned for all communication errors or a timeout.

To Page Top

Notes

• When the option is omitted, the default values are used even if the value specified for the port number in adminagent.properties is outside the specification range. However, if a value outside the specification range is specified directly in this option, a syntax error occurs.

• The adminagentcheck command assumes that it is used from a batch or a shell that monitors operations. Consequently, nothing is output to the standard output or the error output. You must refer to the return value to determine whether or not the Administration Agent is running and whether or not a command error has occurred. Note that the command's usage is output only when a command syntax error occurs.

To Page Top