-HOSTID

Host name of the agent or remote host computer to be pinged (tested).

At least one Host ID must be specified for each run of the ctmping utility. Additional Host IDs can optionally be specified to enable a single run of this utility to test communication with more than one agent computer.

-HOSTTYPE

Describes the type of computer that is being pinged.

REGULAR – A computer that is registered as an agent in the Control-M/Server database. Control-M/Agent is installed on this computer.

REMOTE – A computer that is registered as a remote host in the Control-M/Server database. It is not necessary for a Control-M/Agent to be installed on this computer. A computer that has a Control-M/Agent installed on it, can also be registered as a remote host.

If you do not specify a HOSTTYPE:

• if the host ID of the computer is already defined, the HOSTTYPE that was defined is used again
• if the host ID of the computer was not used previously, then REGULAR is used as the default
• in the event that the type is unknown, that is, still in host discovery state, the utility is unable to complete the request. Wait for the discovery process to complete, then run the utility again.

If you specify a HOSTTYPE:

• if the host ID is already defined in Control-M/Server and it conflicts with the earlier definition (for example, it was defined earlier as REGULAR and you are now specifying REMOTE), then the utility will not be able to complete the request. If the intention was to convert the defined host type, then for more information about how to convert a computer from one type to another, see ctmhostmap and Defining a remote host.
• if the host ID is already defined in Control-M/Server and the HOSTTYPE being specified now is same as that of the earlier definition, then the utility will use the specified HOSTTYPE for the host ID.
• if the host ID has not been previously defined in Control-M/Server, then the utility will use the specified HOSTTYPE for the host ID.

-FILE

Full path and name of a file containing a list of host computers to be pinged.

Each line in the specified file contains:

• the name (host ID) of the agent or remote host (mandatory)
• the HOSTTYPE (optional)

The delimiter between the name and the HOSTTYPE is a blank or any number of blank spaces.

Where the computer type is not specified, a discovery process attempts to determine the type to be used. See -HOSTTYPE above.

EXAMPLE: Assume the following computers must be pinged:

Name                 Type

dime                 not specified

comet                Control-M/Agent

mars                 remote host computer

EXAMPLE: The text below specifies the above details in a file:

dime                                                (HOSTTYPE is not specified)

comet REGULAR

mars REMOTE

-DISCOVER

Indicates whether to update the database.

• Y – Update the database with information gathered by the utility
• N – Do not update the database

  NOTE: If -DISCOVER is not specified, ctmping performs an automatic discovery, as follows:

If an agent is

• available – the Control-M/Server database is updated with the details of the agent or remote host
• unavailable, for a new agent or remote host in the Control-M/Server database, a message is displayed, asking if you want to add the discovered agent to the Control-M/Server database

Default: automatic discovery

-DEBUG

Activates a debug trace at the specified level. Valid levels: 0 through 5. Default: 0. Performance is slower when operating in debug mode. BMC recommends that you activate debug mode only when requested by Technical Support and use the specified level.

-QUIET

Suppresses display of utility output.

-FULLDETAILS

Generates a status report of the communication parameters of each specified agent or remote host. Where an agent is unavailable, the report displays the reason why the agent is unavailable. Where a remote host is available it displays the connection information.