Utilities supplied with the Probe for BMC Patrol V9

Utilities are provided for adding agents to a definition file or removing existing agents from a definition file. These are simpler to use than editing the definition file and also prevent syntax errors.

The Probe for BMC Patrol V9 is supplied with the following command line utilities:

  • nco_patrol_v9_encrypt
  • nco_patrol_v9_connections
  • nco_patrol_v9_ping
  • nco_patrol_v9_remove
  • nco_patrol_v9_write
The following table describes the utilities specific to this probe. For information about generic utilities, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide, (SC14-7530).
Table 1. Utilities

Utility name

Command line arguments

Description

nco_patrol_v9_encrypt

N/A

This utility encrypts a password into the BMC Patrol format. The utility prompts you for a password, then asks for confirmation.

Note: The encrypted password is for use in the BMC Patrol definition file. However, the encryption only works for a single entry of a single target host in BMC Patrol definition file. For multiple entries of a single target host (that is, a single target host but with multiple BMC Patrol agents), use nco_patrol_v9_write.

To create an encrypted password, run the following command:

$OMNIHOME/probes/arch/nco_patrol_v9_encrypt

The utility prompts you to enter and verify a password and then displays the password in encrypted format. This is the password that you use in the definition file.

nco_patrol_v9_ connections

filename timeout (optional)

This utility sends a BMC Patrol ping to each agent listed in the BMC Patrol definition file. The optional timeout is the time (in milliseconds) that the probe waits for a response before moving to the next agent.

nco_patrol_v9_ping

hostname port-number timeout (optional)

This utility sends a BMC Patrol ping to an agent on the specified host and port number. The optional timeout is the time (in milliseconds) that the probe waits for a response.

nco_patrol_v9_remove

filename hostname portnumber

This utility removes the agent on the host and port from the specified BMC Patrol definition file.

nco_patrol_v9_write

filename

This utility adds an agent to the specified BMC Patrol definition file. When the command is executed, you are prompted for the agent details.

Note: If the nco_patrol_v9_write utility fails to add an agent to the definition file, you can add it manually, encrypting the password using the nco_patrol_v9_encrypt utility. When uisng nco_patrol_v9_encrypt, encryption only works for a single entry of a single target host in BMC Patrol definition file. When an existing definition file is used, there will be the following option output on the prompt: "Do you want to append to this file [Y]:" If you enter any character other than y, the file will be overwritten.
Note: All connection messages for the utilities are written to stdout; the message level cannot be set.