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:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"help","params":[]}'

resynch_all

Use the resynch_all command to perform a full resynchronization with the CORBA interface.

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

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

The following command performs a resynchronization:

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

resynch_filter

Use the resynch_filter command to perform a partial resynchronization with the CORBA interface using a custom filter.

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

-data '{"command":"resynch_filter","params":[{"filter":"($h == 3) OR ($h == 4)"}]}'

Note: The HTTP command interface does not suffer the limitation of containing spaces in the filter input.

The following command performs a resynchronization:

$OMNIHOME/bin/nco_http -uri http://localhost:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"resynch_filter", "params":[{"filter":"($h == 3) OR ($h == 4)"}]}'

userid_acknowledge_alarm

Use the userid_acknowledge_alarm command to acknowledge an alarm in the CORBA interface by specifying the Alarm ID (NV_ALARM_ID) and the User ID of the user acknowledging the alarm. If you specify a value for the AckUserId property, the user_id parameter is not required.

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

-data '{"command":"userid_acknowledge_alarm", "params":[{"alarm_id":"exalarmid","user_id":"exuserid"}]}'

Where:

  • exalarmid is the alarm ID to be acknowledged.
  • exuserid is the user ID that acknowledges the alarm.

The following command acknowledges an alarm:

$OMNIHOME/bin/nco_http -uri http://localhost:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"userid_acknowledge_alarm", "params":[{"alarm_id":"abc123","user_id":"netcool"}]}'

userid_unacknowledge_alarm

Use the userid_unacknowledge_alarm command to unacknowledge an alarm in the CORBA interface by specifying the alarm ID (NV_ALARM_ID) and the user ID of the user acknowledging the alarm. If you specify a value for the AckUserId property, the user_id parameter is not required

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

-data '{"command":"userid_unacknowledge_alarm", "params":[{"alarm_id":"exalarmid","user_id":"exuserid"}]}'

Where:

  • exalarmid is the alarm ID to be acknowledged.
  • exuserid is the user ID that acknowledges the alarm.

The following command unacknowledges an alarm:

$OMNIHOME/bin/nco_http -uri http://localhost:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"userid_unacknowledge_alarm", "params":[{"alarm_id":"abc123","user_id":"netcool"}]}'

userid_clear_alarm

Use the userid_clear_alarm command to clear an alarm by specifying the alarm ID (NV_ALARM_ID) and the user ID of the user acknowledging the alarm. If you specify a value for the ClearUserId property, the user_id parameter is not required.

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

-data '{"command":"userid_clear_alarm", "params":[{"alarm_id":"exalarmid","user_id":"exuserid"}]}'

Where:

  • exalarmid is the alarm ID to be acknowledged.
  • exuserid is the user ID that acknowledges the alarm.

The following command clears an alarm:

$OMNIHOME/bin/nco_http -uri http://localhost:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"userid_clear_alarm", "params":[{"alarm_id":"abc123","user_id":"netcool"}]}'

userid_comment_alarm

Use the userid_comment_alarm command to add comments to an alarm by specifying the alarm ID (NV_ALARM_ID), the user ID of the user making the comment, and the comment text. If you specify a value for the CommentUserId property, the user_id parameter is not required.

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

-data '{"command":"userid_comment_alarm", "params":[{"alarm_id":"exalarmid", "user_id":"exuserid", "comment_text":"extext"}]}'

Where:

  • exalarmid is the alarm ID to be acknowledged.
  • exuserid is the user ID that acknowledges the alarm.
  • extext is the text commenting on the alarm.

The following command adds comments to an alarm:

$OMNIHOME/bin/nco_http -uri http://localhost:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"userid_comment_alarm", "params":[{"alarm_id":"abc123", "user_id":"netcool","comment_text":"test"}]}'

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:56100/probes/huawei_u2000_3gpp_corba -datatype application/JSON -method POST -data '{"command":"version","params":[]}'