Get all alarms - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get all alarms","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"],"deprecated":true,"summary":"Get all alarms","description":"\u003cb\u003eBatch Retrieval\u003c/b\u003e \nThe default max batch size for retrieval is set to 100 and maximum 100 objects can be retrieved. \n\u003cb\u003e.startIndex=<value>\u003c/b\u003e 0 based index as a start index of the data to be retrieved \n\u003cb\u003e.maxCount=<value>\u003c/b\u003e Maximum number of objects to be retrieved \n\n\u003cb\u003e\u003cfont color='red'\u003eNew query parameter\u003c/font\u003e\u003c/b\u003e \n\u003cb\u003ealarmtype=<value>\u003c/b\u003e Possible value [system, network, device] \nNote: If not specified device alarms will be returned\r\n\r\nAdditional filters can be provided as Query parameters e.g. \n \u003cb\u003end-ref=<value>\u003c/b\u003e Alarms with the matching node reference will be retrieved, e.g. MD=<CISCO_EMS>!ND=<nodename> \nFDN of the node/device. It can be obtained from the node API response '/restconf/data/v1/cisco-resource-physical:node'. \nFor e.g. in the json format of the response, \"nd.fdn\": \"MD=CISCO_EMS!ND=RON_NCS5700_14.cisco-lab.com\" \n\n\u003cb\u003etp-ref=<value>\u003c/b\u003e Alarms with the matching termination point reference will be retrieved, e.g. MD=<CISCO_EMS>!ND=<nodename>!CTP=name=OTU20/6/0/7;lr=lr-och-transport-unit-2, \nFDN of the termination point. It can be obtained from TP API response '/restconf/data/v1/cisco-resource-ems:termination-point'. \nFor e.g. in the json format of the response, \"tp.fdn\": \"MD=CISCO_EMS!ND=NCS4216-41.cisco.com!FTP=name=BVI101;lr=lr-bridge\" \n\n\u003cb\u003eeq-ref=<value>\u003c/b\u003e Alarms with the matching equipment reference will be retrieved, e.g. MD=<CISCO_EMS>!ND=<nodename>!EQ=<name=PWR-B;partnumber=15454-M6-DC>, \nFDN of the Equipment. It can be obtained from the equipment API response '/restconf/data/v1/cisco-resource-physical:equipment'. \nFor e.g. in the json format of the response, \"eq.fdn\": \"MD=CISCO_EMS!ND=RON_NCS5700_14.cisco-lab.com!EQ=name=0/FT0;partnumber=800-107872-01\", \n\n\u003cb\u003eperceived-severity=<value>\u003c/b\u003e Alarms with the matching perceived severity will be retrieved, possible severity values consist of (critical, major, minor, warning, cleared, indeterminate) \n","operationId":"getAll","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":5},"com.data":{"alm.alarm":[{"alm.alarm-identifier":{"alm.event-identifier":5,"alm.resource-object-ref":"MD=CISCO_EMS!ND=NCS4200-42!FTP=name=GigabitEthernet0/1/7;lr=lr-gigabit-ethernet","alm.probable-cause":"OSPFv3-5-ADJCHG_DOWN"},"alm.uuid":"6a664005-0b24-43a7-aafa-64a399140209","alm.perceived-severity":"major","alm.description":"Process 456, Nbr 192.168.0.41 on GigabitEthernet0/1/7 from 2WAY to DOWN, Neighbor Down: Interface down or detached","alm.category":"OSPF","alm.source-object-ref":"MD=CISCO_EMS!ND=NCS4200-42!FTP=name=GigabitEthernet0/1/7;lr=lr-gigabit-ethernet","alm.source-object-name":"GigabitEthernet0/1/7","alm.source-object-id":442913,"alm.node-ref":"NCS4200-42","alm.business-key":"10.104.120.42:192.168.0.41:GigabitEthernet0/1/7:OSPFv3-5-ADJCHG##SubAlarm@@_1","alm.cause-type":"cause-unknown","alm.ack-state":"acknowledged","alm.remote-interface-ip-address":"10.104.120.42","alm.system-received-time":"2024-09-25 10:57:00.000","alm.system-received-time-iso8601":"2024-09-25T10:57:00.000Z","alm.system-update-time":"2024-10-04 10:01:10.981","alm.system-update-time-iso8601":"2024-10-04T10:01:10.981Z","alm.node-event-time":"2024-09-25 09:17:35.272","alm.node-event-time-iso8601":"2024-09-25T09:17:35.272Z","alm.probable-cause":"OSPFv3-5-ADJCHG_DOWN","alm.service-impacting":"service-impacting-unknown","alm.root-cause-alarm-identifier":{"alm.event-identifier":0},"alm.note":[{"alm.creator-id":"admin","alm.text":"Ack1","alm.note-time":"2024-09-25 12:54:47.122","alm.note-time-iso8601":"2024-09-25T12:54:47.122Z"},{"alm.creator-id":"admin","alm.text":"ack1","alm.note-time":"2024-09-25 11:27:15.14","alm.note-time-iso8601":"2024-09-25T11:27:15.140Z"},{"alm.creator-id":"admin","alm.text":"clear for testing 06062024","alm.note-time":"2024-10-04 10:01:10.981","alm.note-time-iso8601":"2024-10-04T10:01:10.981Z"},{"alm.creator-id":"admin","alm.text":"Unack1","alm.note-time":"2024-09-25 14:02:49.439","alm.note-time-iso8601":"2024-09-25T14:02:49.439Z"},{"alm.creator-id":"admin","alm.text":"unack","alm.note-time":"2024-09-25 11:27:31.104","alm.note-time-iso8601":"2024-09-25T11:27:31.104Z"}]}]}}},"$$ref":"#/components/examples/GetAllAlarmJson"}}},"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":{"ns14:firstIndex":0,"ns14:lastIndex":0,"ns14:iteratorId":5},"data":{"alarm":[{"alarm-identifier":{"ns5:event-identifier":5,"ns5:resource-object-ref":"MD=CISCO_EMS!ND=NCS4200-42!FTP=name=GigabitEthernet0/1/7;lr=lr-gigabit-ethernet","ns5:probable-cause":"OSPFv3-5-ADJCHG_DOWN"},"ns5:uuid":"6a664005-0b24-43a7-aafa-64a399140209","ns5:perceived-severity":"major","ns5:description":"Process 456, Nbr 192.168.0.41 on GigabitEthernet0/1/7 from 2WAY to DOWN, Neighbor Down: Interface down or detached","ns5:category":"OSPF","ns5:source-object-ref":"MD=CISCO_EMS!ND=NCS4200-42!FTP=name=GigabitEthernet0/1/7;lr=lr-gigabit-ethernet","ns5:source-object-name":"GigabitEthernet0/1/7","ns5:source-object-id":442913,"ns5:node-ref":"NCS4200-42","ns5:business-key":"10.104.120.42:192.168.0.41:GigabitEthernet0/1/7:OSPFv3-5-ADJCHG##SubAlarm@@_1","ns5:cause-type":"cause-unknown","ns5:ack-state":"acknowledged","ns5:remote-interface-ip-address":"10.104.120.42","ns5:system-received-time":"2024-09-25 10:57:00.000","ns5:system-received-time-iso8601":"2024-09-25T10:57:00.000Z","ns5:system-update-time":"2024-10-04 10:01:10.981","ns5:system-update-time-iso8601":"2024-10-04T10:01:10.981Z","ns5:node-event-time":"2024-09-25 09:17:35.272","ns5:node-event-time-iso8601":"2024-09-25T09:17:35.272Z","ns5:probable-cause":"OSPFv3-5-ADJCHG_DOWN","ns5:service-impacting":"service-impacting-unknown","root-cause-alarm-identifier":{"ns5:event-identifier":0},"note":[{"ns5:creator-id":"admin","ns5:text":"Ack1","ns5:note-time":"2024-09-25 12:54:47.122","ns5:note-time-iso8601":"2024-09-25T12:54:47.122Z"},{"ns5:creator-id":"admin","ns5:text":"ack1","ns5:note-time":"2024-09-25 11:27:15.14","ns5:note-time-iso8601":"2024-09-25T11:27:15.140Z"},{"ns5:creator-id":"admin","ns5:text":"clear for testing 06062024","ns5:note-time":"2024-10-04 10:01:10.981","ns5:note-time-iso8601":"2024-10-04T10:01:10.981Z"},{"ns5:creator-id":"admin","ns5:text":"Unack1","ns5:note-time":"2024-09-25 14:02:49.439","ns5:note-time-iso8601":"2024-09-25T14:02:49.439Z"},{"ns5:creator-id":"admin","ns5:text":"unack","ns5:note-time":"2024-09-25 11:27:31.104","ns5:note-time-iso8601":"2024-09-25T11:27:31.104Z"}]}]}},"$$ref":"#/components/examples/GetAllAlarmXml"}}}}},"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"}},"method":"get","path":"/cisco-rtm:alarm"}}