Sending property updates to probes (nco_setprobeprop)

You can use the nco_setprobeprop utility to update the value of a probe property. The nco_setprobeprop utility uses the nco_http utility to make the property update over a HTTP or HTTPS connection. nco_setprobeprop is also used by the flood control triggers to put probes into flood control mode.

Before you begin

Ensure that authentication and, if required, an SSL connection is configured. The probe that you want to communicate with must also have its HTTP or HTTPS interface enabled.

About this task

To start the nco_setprobeprop utility, use the following command:

For UNIX operating system$OMNIHOME/bin/nco_setprobeprop command_line_options

For Windows operating system%OMNIHOME%\bin\nco_setprobeprop.cmd command_line_options

If you specify a new value for an existing probe property, the utility will update the property value. If you do not specify a value for a property, the new value of the property will be an empty string.

You can also specify a property name that does not exist and the utility will create the property and set it to the value that you specify for it. In this case, you must have altered the probe’s rules file to handle the property (for example, use %propertyname to get the value of the property). Properties created by the utility are transient and are lost when the probe shuts down.

Command-line options for the nco_setprobeprop utility are described in the following table. Because nco_setprobeprop uses the nco_http utility to communicate with the probe, it can make use of the properties file nco_http.props. You can store frequently used options, such as the user name and password, in nco_http.props instead of entering them each time that you run the utility.

Table 1. nco_setprobeprop command-line options
Command-line option Description
-help Displays help about the command-line options.
-host Specifies the host name where the probe is installed.
-messagelevel Specifies the logging level for messages. The available logging levels are FATAL, ERROR, WARN, INFO, and DEBUG. The default level is INFO.
-name Specifies the name of the property to update or create.
-password Specifies the HTTP password for the update.
-port Specifies the port number on which to communicate with the probe.
-ssl Specifies the use of a HTTPS connection.
-timeout Specifies the timeout period for the HTTP response.
-username Specifies the HTTP user name for the request.
-value Specifies the new value of the property. If you do not specify a value, the new value of the property will be an empty string.

Example

The following example sets the value of the FloodControl property to flood. The probe host is servername and the port is 2000.
$OMNIHOME/bin/nco_setprobeprop -name FloodControl -value flood -host servername
 -port 2000