Get all alarms with symptom - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get all alarms with symptom","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/675abc36-cffe-3586-8c87-12cc4a16cabc","info":{"title":"RESTCONF Fault APIs - Deprecated","description":"RESTCONF Fault APIs exposed by Alarm Rest service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"tags":[{"name":"RESTCONF APIs","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/fault-restconf-deprecated-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/restconf/data/v1","description":"Generated server url"}]},"spec":{"tags":["RESTCONF APIs"],"summary":"Get all alarms with symptom","description":"To retrieve all symptom alarms associated with a single root cause alarm","operationId":"getSymptomAlarmForRootCauseAlarm","requestBody":{"description":"Alarm request","content":{"application/json":{"schema":{"type":"object","description":"Alarm object for request api","xml":{"name":"alarm-request","namespace":"urn:cisco:params:xml:ns:yang:alarms:v1","prefix":"p"},"properties":{"alarm-list":{"type":"object","xml":{"name":"alarm-list","prefix":"p"},"description":"Wrapper of alarm request object","properties":{"alarm":{"type":"array","description":"List of alarm request object","items":{"type":"object","xml":{"name":"alarm","prefix":"p"},"description":"Alarm object for request api","properties":{"alarm-identifier":{"xml":{"prefix":"p"},"type":"object","description":"A complex type to uniquely identify an alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid"},"type":{"type":"string","description":"Alarm type"},"perceived-severity":{"type":"string","description":"Severity of an alarm, including the cleared state","enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"action-performed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"note-list":{"type":"object","xml":{"name":"note-list","prefix":"p"},"description":"Note list for request object","properties":{"text":{"type":"string","description":"Note text"}},"$$ref":"#/components/schemas/NoteListForRequest"}},"$$ref":"#/components/schemas/AlarmForRequest"}}},"$$ref":"#/components/schemas/AlarmListForRequest"}},"$$ref":"#/components/schemas/AlarmRequest"},"examples":{"example":{"summary":"Sample request","value":{"alm.alarm-request":{"alm.alarm-list":{"alm.alarm":[{"alm.alarm-identifier":{"alm.event-identifier":"1447458","alm.resource-object-ref":"MD=CISCO_EMS!ND=EPNNCS4206-120-207.Cisco.com","alm.probable-cause":"FC-REDUNDANCY-LOST"}}]}}},"$$ref":"#/components/examples/AlarmWithRootCauseRequestJson"}}},"application/xml":{"schema":{"type":"object","description":"Alarm object for request api","xml":{"name":"alarm-request","namespace":"urn:cisco:params:xml:ns:yang:alarms:v1","prefix":"p"},"properties":{"alarm-list":{"type":"object","xml":{"name":"alarm-list","prefix":"p"},"description":"Wrapper of alarm request object","properties":{"alarm":{"type":"array","description":"List of alarm request object","items":{"type":"object","xml":{"name":"alarm","prefix":"p"},"description":"Alarm object for request api","properties":{"alarm-identifier":{"xml":{"prefix":"p"},"type":"object","description":"A complex type to uniquely identify an alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid"},"type":{"type":"string","description":"Alarm type"},"perceived-severity":{"type":"string","description":"Severity of an alarm, including the cleared state","enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"action-performed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"note-list":{"type":"object","xml":{"name":"note-list","prefix":"p"},"description":"Note list for request object","properties":{"text":{"type":"string","description":"Note text"}},"$$ref":"#/components/schemas/NoteListForRequest"}},"$$ref":"#/components/schemas/AlarmForRequest"}}},"$$ref":"#/components/schemas/AlarmListForRequest"}},"$$ref":"#/components/schemas/AlarmRequest"},"examples":{"example":{"summary":"Sample request","value":{"alarm-list":{"alarm":[{"alarm-identifier":{"p:event-identifier":"1447458","p:resource-object-ref":"MD=CISCO_EMS!ND=EPNNCS4206-120-207.Cisco.com","p:probable-cause":"FC-REDUNDANCY-LOST"}}]}},"$$ref":"#/components/examples/AlarmWithRootCauseRequestXml"}}}},"required":true},"responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns14"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns14"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns14"}}},"xml":{"prefix":"ns14"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"prefix":"ns14"},"properties":{"alarm":{"type":"array","description":"alarm","items":{"type":"object","xml":{"name":"alarm","prefix":"ns5"},"description":"Parameters used to map from NCS alarm types to X.733 and 3GPP alarm parameters. This grouping is used both in the alamr-model list and in the notification representing an alarm state change.","properties":{"entityTag":{"type":"string","description":"Generic tag"},"alarm-identifier":{"type":"object","description":"A complex type to uniquely identify an alarm","xml":{"name":"alarm-identifier","prefix":"ns5"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid","xml":{"name":"uuid","prefix":"ns5"}},"type":{"type":"string","description":"Alarm type","xml":{"name":"type","prefix":"ns5"}},"perceivedSeverity":{"type":"string","description":"Severity of an alarm, including the cleared state","xml":{"name":"perceived-severity","prefix":"ns5"},"enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"eventType":{"type":"string","description":"The event type as defined in X.733/X.736.; reference:ITU Recommendation X.733, 'Information Technology - Open Systems Interconnection - System Management: Alarm Reporting Function', 1992","xml":{"name":"event-type","prefix":"ns5"},"enum":["OTHER","COMMUNICATIONS_ALARM","QUALITY_OF_SERVICE_ALARM","PROCESSING_ERROR_ALARM","EQUIPMENT_ALARM","ENVIRONMENTAL_ALARM","INTEGRITY_VIOLATION","OPERATIONAL_VIOLATION","PHYSICAL_VIOLATION","SECURITY_SERVICE_OR_MECHANISM_VIOLATION","TIME_DOMAIN_VIOLATION"]},"description":{"type":"string","description":"Alarm description","xml":{"name":"description","prefix":"ns5"}},"category":{"type":"string","description":"System defined alarm catgories. Note: Use alarm-type base identify","xml":{"name":"category","prefix":"ns5"}},"sourceObjectRef":{"type":"string","description":"FDN of the source manged object that alarm is emitted","xml":{"name":"source-object-ref","prefix":"ns5"}},"sourceObjectName":{"type":"string","description":"Source manged object name that the alarm is emitted","xml":{"name":"source-object-name","prefix":"ns5"}},"sourceObjectId":{"type":"string","description":"Optional. Internal id for the source object if applicable","xml":{"name":"source-object-id","prefix":"ns5"}},"nodeRef":{"type":"string","description":"Source node that the alarm is emitted; i.e. device or server","xml":{"name":"node-ref","prefix":"ns5"}},"businessKey":{"type":"string","description":"Optional opaque field containing info for alarm correlation business logic","xml":{"name":"business-key","prefix":"ns5"}},"hasClear":{"type":"string","description":"Indicates if the alarm has a potential clear notification","xml":{"name":"has-clear","prefix":"ns5"}},"causeType":{"type":"string","description":"Root Cause indication","xml":{"name":"cause-type","prefix":"ns5"},"enum":["ROOT_CAUSE","SYMPTOM","CAUSE_UNKNOWN"]},"ackState":{"type":"string","description":"Indicates whether the alarm is acknowledged, un-acknowleged","xml":{"name":"ack-state","prefix":"ns5"},"enum":["ACKNOWLEDGED","UNACKNOWLEDGED","ACK_NOT_APPLICABLE"]},"remoteInterfaceIpAddress":{"type":"string","description":"Any remote associated interface IP address; for Access Point, it is the controller port IP","xml":{"name":"remote-interface-ip-address","prefix":"ns5"}},"systemReceivedTime":{"type":"string","description":"Application or system time stamp when the alarm is first processed","xml":{"name":"system-received-time","prefix":"ns5"}},"systemReceivedTimeIso8601":{"type":"string","description":"Application or system time stamp when the alarm is first processed","xml":{"name":"system-received-time-iso8601","prefix":"ns5"}},"systemUpdateTime":{"type":"string","description":"last update in the application system","xml":{"name":"system-update-time","prefix":"ns5"}},"systemUpdateTimeIso8601":{"type":"string","description":"last update in the application system","xml":{"name":"system-update-time-iso8601","prefix":"ns5"}},"nodeEventTime":{"type":"string","description":"Node or device time stamp when the alarm is generated","xml":{"name":"node-event-time","prefix":"ns5"}},"nodeEventTimeIso8601":{"type":"string","description":"Node or device time stamp when the alarm is generated using ISO 8601 format yyyy-MM-dd'T'HH:mm:ss.SSSXXX","xml":{"name":"node-event-time-iso8601","prefix":"ns5"}},"probableCause":{"type":"string","description":"The probable cause for the alarm originally defined by X.733 and subsequent standards. Due to the history of problems in maintaining a standardized probable cause the probable cause is not unique. A best effort mapping of the alarm to existing probable causes are used","xml":{"name":"probable-cause","prefix":"ns5"}},"serviceAffecting":{"type":"string","description":"This indicator is directly from NCS 2K devices. For EMS SIA indicator, please refer to service-impacting attribute","xml":{"name":"service-affecting","prefix":"ns5"},"enum":["SERVICE_AFFECTING","NON_SERVICE_AFFECTING","SERVICE_AFFECTING_UNKNOWN"]},"serviceImpacting":{"type":"string","description":"Indicates service impacting through EMS Service Impact Analysis","xml":{"name":"service-impacting","prefix":"ns5"},"enum":["SERVICE_IMPACTING","NON_SERVICE_IMPACTING","SERVICE_IMPACTING_UNKNOWN"]},"owner":{"type":"string","description":"Alarm owner","xml":{"name":"owner","prefix":"ns5"}},"actionPerformed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","xml":{"name":"action-performed","prefix":"ns5"},"enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"impactedObjects":{"type":"array","description":"Fully Distinguished Name of the Objects that might be affected by this alarm","xml":{"name":"impacted-objects","prefix":"ns5"},"items":{"type":"string"}},"rootCauseObjects":{"type":"array","description":"Fully Distinguished Name of the Objects that are candidates for causing the alarm","xml":{"name":"root-cause-objects","prefix":"ns5"},"items":{"type":"string"}},"root-cause-alarm-identifier":{"type":"object","description":"A complex type to uniquely identify an alarm","xml":{"name":"root-cause-alarm-identifier","prefix":"ns5"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID"},"resourceObjectRef":{"type":"string","description":"fdn"},"probableCause":{"type":"string","description":"Probable cause"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/RootCauseAlarmIdentifier"},"noteList":{"type":"array","description":"List of notes added by the operator","xml":{"name":"note-list","prefix":"ns5"},"items":{"type":"object","description":"Alarm notes","properties":{"entityTag":{"type":"string","description":"Generic tag"},"creatorId":{"type":"string","description":"Identifier of the person who annotated the alarm"},"text":{"type":"string","description":"Note text"},"noteTime":{"type":"string","description":"Time when alarm note added"},"noteTimeIso8601":{"type":"string","description":"Time iso when alarm note added"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/NoteList"}},"userDefinedFields":{"type":"object","description":"User defined Fields list","properties":{"entityTag":{"type":"string","description":"Generic tag"},"userDefinedField":{"type":"array","description":"User defined label and value related to alarm","items":{"type":"object","description":"User defined label and value related to alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"label":{"type":"string","description":"label"},"value":{"type":"string","description":"value"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/UserDefinedField"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/UserDefinedFields"},"note":{"type":"array","description":"Alarm notes","items":{"type":"object","xml":{"name":"note","prefix":"ns5"},"description":"Alarm notes","properties":{"entityTag":{"type":"string","description":"Generic tag"},"creatorId":{"type":"string","description":"Identifier of the person who annotated the alarm","xml":{"name":"creator-id","prefix":"ns5"}},"text":{"type":"string","description":"Note text","xml":{"name":"text","prefix":"ns5"}},"noteTime":{"type":"string","description":"Time when alarm note added","xml":{"name":"note-time","prefix":"ns5"}},"noteTimeIso8601":{"type":"string","description":"Time iso when alarm note added","xml":{"name":"note-time-iso8601","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Note"}},"alarmDestination":{"type":"array","description":"Alarm destination","xml":{"name":"alarm-destination","prefix":"ns5"},"items":{"type":"object","description":"Alarm destination","properties":{"entityTag":{"type":"string","description":"Generic tag"},"destination":{"type":"string","description":"Alarm destination"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmDestination"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Alarm"}}},"$$ref":"#/components/schemas/Data"}},"$$ref":"#/components/schemas/ResponseMessage"},"examples":{"example":{"summary":"Sample response","value":{"com.response-message":{"com.header":{"com.firstIndex":0,"com.lastIndex":0,"com.iteratorId":522545},"com.data":{"alm.alarm":[{"alm.alarm-identifier":{"alm.event-identifier":522545,"alm.resource-object-ref":"MD=CISCO_EPNM!ND=NCS4216-41.cisco.com","alm.probable-cause":"WARM_START"},"alm.perceived-severity":"cleared","alm.description":"Warm start. Device '10.104.120.41'. : Cleared due to auto clearing service","alm.category":"Switches and Routers","alm.source-object-ref":"MD=CISCO_EPNM!ND=NCS4216-41.cisco.com","alm.source-object-id":0,"alm.node-ref":"NCS4216-41.cisco.com","alm.business-key":"WARM_START:10.104.120.41:Mod##SubAlarm@@_1","alm.cause-type":"root-cause","alm.ack-state":"unacknowledged","alm.remote-interface-ip-address":"10.104.120.41","alm.system-received-time":"2024-10-05 11:33:19.000","alm.system-received-time-iso8601":"2024-10-05T11:33:19.000Z","alm.system-update-time":"2024-10-06 16:32:06.377","alm.system-update-time-iso8601":"2024-10-06T16:32:06.377Z","alm.probable-cause":"WARM_START","alm.service-affecting":"service-affecting-unknown","alm.service-impacting":"service-impacting-unknown","alm.root-cause-alarm-identifier":{"alm.event-identifier":0},"alm.note":[{"alm.creator-id":"admin","alm.text":"Alarm unacknowledged ","alm.note-time":"2024-10-05 15:46:55.75","alm.note-time-iso8601":"2024-10-05T15:46:55.750Z"},{"alm.creator-id":"admin","alm.text":"Test Ack123","alm.note-time":"2024-10-05 15:45:28.012","alm.note-time-iso8601":"2024-10-05T15:45:28.012Z"},{"alm.creator-id":"admin","alm.text":"Alarm acknowledged ","alm.note-time":"2024-10-05 15:45:28.211","alm.note-time-iso8601":"2024-10-05T15:45:28.211Z"},{"alm.creator-id":"admin","alm.text":"Test Ack123","alm.note-time":"2024-10-05 15:46:55.376","alm.note-time-iso8601":"2024-10-05T15:46:55.376Z"}]}]}}},"$$ref":"#/components/examples/GetAlarmWithRootCauseJson"}}},"application/xml":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns14"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns14"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns14"}}},"xml":{"prefix":"ns14"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"prefix":"ns14"},"properties":{"alarm":{"type":"array","description":"alarm","items":{"type":"object","xml":{"name":"alarm","prefix":"ns5"},"description":"Parameters used to map from NCS alarm types to X.733 and 3GPP alarm parameters. This grouping is used both in the alamr-model list and in the notification representing an alarm state change.","properties":{"entityTag":{"type":"string","description":"Generic tag"},"alarm-identifier":{"type":"object","description":"A complex type to uniquely identify an alarm","xml":{"name":"alarm-identifier","prefix":"ns5"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID","xml":{"name":"event-identifier","prefix":"ns5"}},"resourceObjectRef":{"type":"string","description":"fdn","xml":{"name":"resource-object-ref","prefix":"ns5"}},"probableCause":{"type":"string","description":"Probable cause","xml":{"name":"probable-cause","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmIdentifier"},"uuid":{"type":"string","description":"Alarm uuid","xml":{"name":"uuid","prefix":"ns5"}},"type":{"type":"string","description":"Alarm type","xml":{"name":"type","prefix":"ns5"}},"perceivedSeverity":{"type":"string","description":"Severity of an alarm, including the cleared state","xml":{"name":"perceived-severity","prefix":"ns5"},"enum":["CLEARED","INDETERMINATE","MINOR","WARNING","MAJOR","CRITICAL"]},"eventType":{"type":"string","description":"The event type as defined in X.733/X.736.; reference:ITU Recommendation X.733, 'Information Technology - Open Systems Interconnection - System Management: Alarm Reporting Function', 1992","xml":{"name":"event-type","prefix":"ns5"},"enum":["OTHER","COMMUNICATIONS_ALARM","QUALITY_OF_SERVICE_ALARM","PROCESSING_ERROR_ALARM","EQUIPMENT_ALARM","ENVIRONMENTAL_ALARM","INTEGRITY_VIOLATION","OPERATIONAL_VIOLATION","PHYSICAL_VIOLATION","SECURITY_SERVICE_OR_MECHANISM_VIOLATION","TIME_DOMAIN_VIOLATION"]},"description":{"type":"string","description":"Alarm description","xml":{"name":"description","prefix":"ns5"}},"category":{"type":"string","description":"System defined alarm catgories. Note: Use alarm-type base identify","xml":{"name":"category","prefix":"ns5"}},"sourceObjectRef":{"type":"string","description":"FDN of the source manged object that alarm is emitted","xml":{"name":"source-object-ref","prefix":"ns5"}},"sourceObjectName":{"type":"string","description":"Source manged object name that the alarm is emitted","xml":{"name":"source-object-name","prefix":"ns5"}},"sourceObjectId":{"type":"string","description":"Optional. Internal id for the source object if applicable","xml":{"name":"source-object-id","prefix":"ns5"}},"nodeRef":{"type":"string","description":"Source node that the alarm is emitted; i.e. device or server","xml":{"name":"node-ref","prefix":"ns5"}},"businessKey":{"type":"string","description":"Optional opaque field containing info for alarm correlation business logic","xml":{"name":"business-key","prefix":"ns5"}},"hasClear":{"type":"string","description":"Indicates if the alarm has a potential clear notification","xml":{"name":"has-clear","prefix":"ns5"}},"causeType":{"type":"string","description":"Root Cause indication","xml":{"name":"cause-type","prefix":"ns5"},"enum":["ROOT_CAUSE","SYMPTOM","CAUSE_UNKNOWN"]},"ackState":{"type":"string","description":"Indicates whether the alarm is acknowledged, un-acknowleged","xml":{"name":"ack-state","prefix":"ns5"},"enum":["ACKNOWLEDGED","UNACKNOWLEDGED","ACK_NOT_APPLICABLE"]},"remoteInterfaceIpAddress":{"type":"string","description":"Any remote associated interface IP address; for Access Point, it is the controller port IP","xml":{"name":"remote-interface-ip-address","prefix":"ns5"}},"systemReceivedTime":{"type":"string","description":"Application or system time stamp when the alarm is first processed","xml":{"name":"system-received-time","prefix":"ns5"}},"systemReceivedTimeIso8601":{"type":"string","description":"Application or system time stamp when the alarm is first processed","xml":{"name":"system-received-time-iso8601","prefix":"ns5"}},"systemUpdateTime":{"type":"string","description":"last update in the application system","xml":{"name":"system-update-time","prefix":"ns5"}},"systemUpdateTimeIso8601":{"type":"string","description":"last update in the application system","xml":{"name":"system-update-time-iso8601","prefix":"ns5"}},"nodeEventTime":{"type":"string","description":"Node or device time stamp when the alarm is generated","xml":{"name":"node-event-time","prefix":"ns5"}},"nodeEventTimeIso8601":{"type":"string","description":"Node or device time stamp when the alarm is generated using ISO 8601 format yyyy-MM-dd'T'HH:mm:ss.SSSXXX","xml":{"name":"node-event-time-iso8601","prefix":"ns5"}},"probableCause":{"type":"string","description":"The probable cause for the alarm originally defined by X.733 and subsequent standards. Due to the history of problems in maintaining a standardized probable cause the probable cause is not unique. A best effort mapping of the alarm to existing probable causes are used","xml":{"name":"probable-cause","prefix":"ns5"}},"serviceAffecting":{"type":"string","description":"This indicator is directly from NCS 2K devices. For EMS SIA indicator, please refer to service-impacting attribute","xml":{"name":"service-affecting","prefix":"ns5"},"enum":["SERVICE_AFFECTING","NON_SERVICE_AFFECTING","SERVICE_AFFECTING_UNKNOWN"]},"serviceImpacting":{"type":"string","description":"Indicates service impacting through EMS Service Impact Analysis","xml":{"name":"service-impacting","prefix":"ns5"},"enum":["SERVICE_IMPACTING","NON_SERVICE_IMPACTING","SERVICE_IMPACTING_UNKNOWN"]},"owner":{"type":"string","description":"Alarm owner","xml":{"name":"owner","prefix":"ns5"}},"actionPerformed":{"type":"string","description":"Indicates if the alarm is Acknowledges, De-acknowledged, Delete. It indicates operator actions","xml":{"name":"action-performed","prefix":"ns5"},"enum":["ALARM_CLEAR","ALARM_ACKNOWLEDGE","ALARM_UNACKNOWLEDGE","ALARM_CLOSE","ALARM_DELETE","ALARM_ANOTATE","ALARM_ACTION_UNKNOWN"]},"impactedObjects":{"type":"array","description":"Fully Distinguished Name of the Objects that might be affected by this alarm","xml":{"name":"impacted-objects","prefix":"ns5"},"items":{"type":"string"}},"rootCauseObjects":{"type":"array","description":"Fully Distinguished Name of the Objects that are candidates for causing the alarm","xml":{"name":"root-cause-objects","prefix":"ns5"},"items":{"type":"string"}},"root-cause-alarm-identifier":{"type":"object","description":"A complex type to uniquely identify an alarm","xml":{"name":"root-cause-alarm-identifier","prefix":"ns5"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"eventIdentifier":{"type":"string","description":"Unique event ID derived from trap ID"},"resourceObjectRef":{"type":"string","description":"fdn"},"probableCause":{"type":"string","description":"Probable cause"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/RootCauseAlarmIdentifier"},"noteList":{"type":"array","description":"List of notes added by the operator","xml":{"name":"note-list","prefix":"ns5"},"items":{"type":"object","description":"Alarm notes","properties":{"entityTag":{"type":"string","description":"Generic tag"},"creatorId":{"type":"string","description":"Identifier of the person who annotated the alarm"},"text":{"type":"string","description":"Note text"},"noteTime":{"type":"string","description":"Time when alarm note added"},"noteTimeIso8601":{"type":"string","description":"Time iso when alarm note added"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/NoteList"}},"userDefinedFields":{"type":"object","description":"User defined Fields list","properties":{"entityTag":{"type":"string","description":"Generic tag"},"userDefinedField":{"type":"array","description":"User defined label and value related to alarm","items":{"type":"object","description":"User defined label and value related to alarm","properties":{"entityTag":{"type":"string","description":"Generic tag"},"label":{"type":"string","description":"label"},"value":{"type":"string","description":"value"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/UserDefinedField"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/UserDefinedFields"},"note":{"type":"array","description":"Alarm notes","items":{"type":"object","xml":{"name":"note","prefix":"ns5"},"description":"Alarm notes","properties":{"entityTag":{"type":"string","description":"Generic tag"},"creatorId":{"type":"string","description":"Identifier of the person who annotated the alarm","xml":{"name":"creator-id","prefix":"ns5"}},"text":{"type":"string","description":"Note text","xml":{"name":"text","prefix":"ns5"}},"noteTime":{"type":"string","description":"Time when alarm note added","xml":{"name":"note-time","prefix":"ns5"}},"noteTimeIso8601":{"type":"string","description":"Time iso when alarm note added","xml":{"name":"note-time-iso8601","prefix":"ns5"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Note"}},"alarmDestination":{"type":"array","description":"Alarm destination","xml":{"name":"alarm-destination","prefix":"ns5"},"items":{"type":"object","description":"Alarm destination","properties":{"entityTag":{"type":"string","description":"Generic tag"},"destination":{"type":"string","description":"Alarm destination"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/AlarmDestination"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Alarm"}}},"$$ref":"#/components/schemas/Data"}},"$$ref":"#/components/schemas/ResponseMessage"},"examples":{"example":{"summary":"Sample response","value":{"header":{"firstIndex":0,"lastIndex":0,"iteratorId":522545},"data":{"alarm":[{"alarm-identifier":{"ns5:event-identifier":522545,"ns5:resource-object-ref":"MD=CISCO_EPNM!ND=NCS4216-41.cisco.com","ns5:probable-cause":"WARM_START"},"ns5:perceived-severity":"cleared","ns5:description":"Warm start. Device '10.104.120.41'. : Cleared due to auto clearing service","ns5:category":"Switches and Routers","ns5:source-object-ref":"MD=CISCO_EPNM!ND=NCS4216-41.cisco.com","ns5:source-object-id":0,"ns5:node-ref":"NCS4216-41.cisco.com","ns5:business-key":"WARM_START:10.104.120.41:Mod##SubAlarm@@_1","ns5:cause-type":"root-cause","ns5:ack-state":"unacknowledged","ns5:remote-interface-ip-address":"10.104.120.41","ns5:system-received-time":"2024-10-05 11:33:19.000","ns5:system-received-time-iso8601":"2024-10-05T11:33:19.000Z","ns5:system-update-time":"2024-10-06 16:32:06.377","ns5:system-update-time-iso8601":"2024-10-06T16:32:06.377Z","ns5:probable-cause":"WARM_START","ns5:service-affecting":"service-affecting-unknown","ns5:service-impacting":"service-impacting-unknown","root-cause-alarm-identifier":{"ns5:event-identifier":0},"note":[{"ns5:creator-id":"admin","ns5:text":"Alarm unacknowledged ","ns5:note-time":"2024-10-05 15:46:55.75","ns5:note-time-iso8601":"2024-10-05T15:46:55.750Z"},{"ns5:creator-id":"admin","ns5:text":"Test Ack123","ns5:note-time":"2024-10-05 15:45:28.012","ns5:note-time-iso8601":"2024-10-05T15:45:28.012Z"},{"ns5:creator-id":"admin","ns5:text":"Alarm acknowledged ","ns5:note-time":"2024-10-05 15:45:28.211","ns5:note-time-iso8601":"2024-10-05T15:45:28.211Z"},{"ns5:creator-id":"admin","ns5:text":"Test Ack123","ns5:note-time":"2024-10-05 15:46:55.376","ns5:note-time-iso8601":"2024-10-05T15:46:55.376Z"}]}]}},"$$ref":"#/components/examples/GetAlarmWithRootCauseXml"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"deprecated":true,"method":"post","path":"/cisco-rtm:alarm-with-root-cause"}}