Probe commands

The following sections define the structure of the JavaScript Object Notation (JSON)-formatted commands that you can send to the probe. There is an example of each command.

All the examples use a probe URI of http://localhost and a HTTP listening port of 8080.

help

Use the help command to receive help information about the HTTP/HTTPS command interface.

The format of the -data option for the help command is:

-data '{"command":"help","params":[]}'

The following command returns help information:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"help", "params":[]}'

name

Use the name command to display the name of the probe.

The format of the -data option for the name command is:

-data '{"command":"name","params":[]}'

The following command displays the name of the probe:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"name","params":[]}'

registerNotification

Use the registerNotification command to register the advanced JMS filter XML file specified by the AdvancedFilterConfigFile property.

The format of the -data option for the registerNotification command is:

-data '{"command":"registerNotification","params":[]}'

The following command registers the advanced JMS filter XML file specified by the AdvancedFilterConfigFile property.:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"registerNotification","params":[]}'

registerNotificationFile

Use the registerNotificationFile command to register an alternative JMS filter XML file.

The format of the -data option for the registerNotificationFile command is:

-data '{"command":"registerNotificationFile", "params":[{"XML_config_file_path":"alternative_jms_filter"}]}'

Where alternative_jms_filter is the path to the alternative JMS filter XML file that you want to register.

The following command registers the file /opt/IBM/tivoli/netcool/omnibus/var/registerNotifcaton.txt as the alternative JMS filter XML file:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"registerNotificationFile", "params":[{"XML_config_file_path":"/opt/IBM/tivoli/netcool/omnibus/var/registerNotifcaton.txt"}]}'

resync

Use the resync command to perform a resynchronization using the parameters specified by the following properties in the properties file:

  • XMLretreiveUseInService
  • NfmpServerUserName
  • NfmpServerPassword

The format of the -data option for the resync command is:

-data '{"command":"resync","params":[]}'

The following command performs a resynchronization:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"resync","params":[]}'

shutdownprobe

Use the shutdownprobe command to shut down the probe.

The format of the -data option for the shutdownprobe command is:

-data '{"command":"shutdownprobe","params":[]}'

The following command shuts down the probe:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"shutdownprobe", "params":[]}'

version

Use the version command to print the version of the probe.

The format of the -data option for the version command is:

-data '{"command":"version","params":[]}'

The following command returns version information:

$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/nokia_nfmp -datatype application/JSON -method POST -data '{"command":"version", "params":[]}'