Data - Crosswork Network Controller 7.1 APIs

{"type":"model","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":{"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","title":"Data"}}