Commands supported by the probe over HTTP/HTTPS
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.
Generic HTTP Command Structure
All the examples use a probe URI of http://localhost and a HTTP listening
port of 8080.
/nco_http -uri http://localhost8080/probes/ca_spectrum_corba -datatype
application/json
Command Parameters
Where the Command Parameters portion of the Generic HTTP Command Structure is substitute with samples from each command's description as follows:
acknowledgeAlarm
Use the acknowledgeAlarm command to acknowledge an alarm.
The format of the -data option for the acknowledgeAlarm
command is:
-data '{"command":"acknowledgeAlarm", "params":[{"alarm_id":"alarmId",
"spectrumName":"MySpectrumServerName"}]}' -method POST
clearAlarm
Use the clearAlarm command to clear an alarm.
The format of the -data option for the clearAlarm command
is:
-data '{"command":"clearAlarm", "params":[{"alarm_id":"alarmId",
"spectrumName":"MySpectrumServerName"}]}' -method POST
resync
Use the resync command to perform a complete resynchronization with the endpoint.
The format of the -data option for the resync command
is:
-data '{"command":"resync", "params":[{"spectrumName":"MySpectrumServerName"}]}' -method
POST
unacknowledgeAlarm
Use the unacknowledgeAlarm command to unacknowledge an alarm.
The format of the -data option for the unacknowledgeAlarm
command is:
-data '{"command":"unacknowledgeAlarm",
"params":[{"alarm_id":"alarmId", "spectrumName":"MySpectrumServerName"}]}'
-method POST
updateEventList
Use the updateEventList command to event list of an alarm by specifying the alarm identifier, the event list identifier, and the SpectroSERVER host name.
The format of the -data option for the updateEventList
command is:
-data '{"command":"updateEventList", "params":[{"alarm_id":"alarmId",
"eventIDList":"MyEventIDList","spectrumName:"MySpectrumName"}]}'
updateStatus
Use the updateStatus command to update the status of an alarm by specifying the alarm identifier, the new status, and the SpectroSERVER host name.
The format of the -data option for the updateStatus command
is:
-data '{"command":"updateStatus", "params":[{"alarm_id":"alarmid",
"status":"MyStatus","spectrumName":"MySpectrumServerName"}]}' -method POST
updateTroubleShooterModel
Use the updateTroubleShooterModel command to update the troubleshooter type of an alarm by specifying the alarm identifier, the new troubleshooter type, and the SpectroSERVER host name.
The format of the -data option for the
updateTroubleShooterModel command is:
-data
'{"command":"updateTroubleShooterModel","params":[{"alarm_id"alarmId",
"name":"MyTroubleShooterName","spectrumName":"MySpectrumServerName"}]}' -method POST
updateTroubleShooterName
Use the updateTroubleShooterName command to update the troubleshooter name of an alarm by specifying the alarm identifier, the new troubleshooter name, and the SpectroSERVER host name.
The format of the -data option for the
updateTroubleShooterName command is:
-data
'{"command":"updateTroubleShooterName","params":[{"alarm_id":"alarmId",
"name":"MyTroubleShooterName","spectrumName":"MySpectrumServerName"}]}' -method POST
updateTroubleTicket
Use the updateTroubleTicket command to update the trouble ticket number for an alarm by specifying the alarm identifier, the new ticket identifier, and the SpectroSERVER host name.
The format of the -data option for the updateTroubleTicket
command is:
-data
'{"command":"updateTroubleTicket","params":["alarm_id":"alarmID",
"ticketID":"MyTicketID","spectrumName":"MySpectrumServerName"}]}' -method POST