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 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/generic_mtosi
-datatype application/JSON -method POST -data ’{"command":"help", "params":[]}’
acknowledgeAlarm
Use the acknowledgeAlarm command to call the
acknowledgeAlarms API on the MTOSI NMS/EMS.
The format of the -data option for the acknowledgeAlarm
command is: -data ’{"command":"acknowledgeAlarm","params":[]}’
The following command calls the acknowledgeAlarms API:
$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/generic_mtosi
-datatype application/JSON -method POST -data
’{"command":"acknowledgeAlarm", "params":
[{"rdn":"MD=TejasEMS,ME=10.1.1.1,OS=TejasEMS,ObjectName=VCG-1-5-173,IPAddress=10.1.1.1,Deferred=0,AdditionalInformation=,pid=3,ObjectLabel=VCG-1-5-173,ManagedElementName=JPR_JAP_901_ME610_N","probableCause":"RU=false,Contra=false,Qualifier=724,ProbableCause=TEST_FAILED","layerRate":"layerRate=1,ext=LR_Not_Applicable"}]}'
unacknowledgeAlarm
Use the unacknowledgeAlarm command to unacknowledgeAlarms API
on the MTOSI NMS/EMS.
The format of the -data option for the unacknowledgeAlarm
command is: -data ’{"command":"unacknowledgeAlarm","params":[]}’
The following command calls the unacknowledgeAlarms API::
$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/generic_mtosi
-datatype application/JSON -method POST -data
’{"command":"unacknowledgeAlarm", "params":
[{"rdn":"MD=TejasEMS,ME=10.1.1.1,OS=TejasEMS,ObjectName=VCG-1-5-173,IPAddress=10.1.1.1,Deferred=0,AdditionalInformation=,pid=3,ObjectLabel=VCG-1-5-173,ManagedElementName=JPR_JAP_901_ME610_N","probableCause":"RU=false,Contra=false,Qualifier=724,ProbableCause=TEST_FAILED","layerRate":"layerRate=1,ext=LR_Not_Applicable"}]}'
resync
Use the resync command to start the resynchronization with the targeted EMS.
The format of the -data option for the resync command is:
-data ’{"command":"version","params":[]}’
The following command starts the resynchronization with the targeted EMS:
$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/generic_mtosi
-datatype application/JSON -method POST -data ’{"command":"resync",
"params":[]}
resync_filter
Use the resync_filter command to start the resynchronization with the targeted EMS using an input filter.
The format of the -data option for the resync_filter command
is: -data ’{"command":"resync_filter","params":[]}’
The following command starts the resynchronization with the targeted EMS using an input filter:
$OMNIHOME/bin/nco_http -uri http://10.3.169.139:8080/probes/generic_mtosi -datatype
application/JSON -method POST -data '{"command": "resync_filter", "params":
[{"filter":"/opt/IBM/tivoli/netcool/omnibus/probes/linux2x86/time_based_resync_filter.xml"}]}'
name
Use the name command to print the version of the probe.
The format of the -data option of the name command is
-data ’{"command":"version","params":[]}’
The following command returns version information:
$OMNIHOME/bin/nco_http -uri http://localhost:8080/probes/generic_mtosi
-datatype application/JSON -method POST -data ’{"command":"name",
"params":[]}’