@itentialopensource/adapter-versa_director

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/vnms/fault/alarm/assign": { "post": { "tags": [ "Alarms" ], "operationId": "assignAlarmObject", "description": "The parameters and request body are for method: assignAlarmObject. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alarm", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "assignee", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Alarms" ], "operationId": "updateAlarmAssignee", "description": "The parameters and request body are for method: updateAlarmAssignee. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "assignee", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "managedObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnms/fault/alarm/clear": { "post": { "tags": [ "Alarms" ], "operationId": "clearAlarm", "description": "The parameters and request body are for method: clearAlarm. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "managedObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnms/fault/alarm/handle": { "post": { "tags": [ "Alarms" ], "operationId": "handleAlarmObject", "description": "The parameters and request body are for method: handleAlarmObject. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alarmAlarmHandlings0AssignedBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmAlarmHandlings0Description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmAlarmHandlings0State", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmAlarmHandlings0Time", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmAlarmHandlings0User", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmDevice", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmDeviceGroup", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmDeviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmIsCleared", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmLastAlarmText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmLastPerceivedSeverity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmLastStatusChangeTimeStamp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmOrg", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmSerial", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmSeverity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmStatusChanges0AlarmText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmStatusChanges0EventTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmStatusChanges0ReceivedTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmStatusChanges0Severity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "assignee", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Alarms" ], "operationId": "updateHandleAlarm", "description": "The parameters and request body are for method: updateHandleAlarm. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "managedObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnms/fault/alarm/handling": { "get": { "tags": [ "Alarms" ], "operationId": "getAlarmHandling", "description": "The parameters and request body are for method: getAlarmHandling. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "alarmHandlings": { "type": "array", "items": { "type": "object", "properties": { "assignedBy": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "time": { "type": "string" }, "user": { "type": "string" } } } }, "device": { "type": "string" }, "deviceGroup": { "type": "string" }, "deviceName": { "type": "string" }, "isCleared": { "type": "string" }, "lastAlarmText": { "type": "string" }, "lastPerceivedSeverity": { "type": "string" }, "lastStatusChangeTimeStamp": { "type": "string" }, "object": { "type": "string" }, "org": { "type": "string" }, "serialNum": { "type": "string" }, "severity": { "type": "string" }, "specific-problem": { "type": "string" }, "statusChanges": { "type": "array", "items": { "type": "object", "properties": { "alarmText": { "type": "string" }, "eventTime": { "type": "string" }, "receivedTime": { "type": "string" }, "severity": { "type": "string" } } } }, "type": { "type": "string" } } }, "example": { "alarmHandlings": [ { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" } ], "device": "SDWAN-Branch2", "deviceGroup": "San-Jose-DG", "deviceName": "SDWAN-Branch2", "isCleared": "true", "lastAlarmText": "CPU usage on appliance R2Controller exceeded hard limit", "lastPerceivedSeverity": "critical", "lastStatusChangeTimeStamp": "2020-01-01 12:02:44", "object": "vni-0/0", "org": "Tenant-2", "serialNum": "string", "severity": "string", "specific-problem": "string", "statusChanges": [ { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" }, { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" } ], "type": "interface-down" } } } } }, "parameters": [ { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "managedObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Alarms" ], "operationId": "getAlarmHandlingObject", "description": "The parameters and request body are for method: getAlarmHandlingObject. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "alarmHandlings": { "type": "array", "items": { "type": "object", "properties": { "assignedBy": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "time": { "type": "string" }, "user": { "type": "string" } } } }, "device": { "type": "string" }, "deviceGroup": { "type": "string" }, "deviceName": { "type": "string" }, "isCleared": { "type": "string" }, "lastAlarmText": { "type": "string" }, "lastPerceivedSeverity": { "type": "string" }, "lastStatusChangeTimeStamp": { "type": "string" }, "object": { "type": "string" }, "org": { "type": "string" }, "serialNum": { "type": "string" }, "severity": { "type": "string" }, "specific-problem": { "type": "string" }, "statusChanges": { "type": "array", "items": { "type": "object", "properties": { "alarmText": { "type": "string" }, "eventTime": { "type": "string" }, "receivedTime": { "type": "string" }, "severity": { "type": "string" } } } }, "type": { "type": "string" } } }, "example": { "alarmHandlings": [ { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" } ], "device": "SDWAN-Branch2", "deviceGroup": "San-Jose-DG", "deviceName": "SDWAN-Branch2", "isCleared": "true", "lastAlarmText": "CPU usage on appliance R2Controller exceeded hard limit", "lastPerceivedSeverity": "critical", "lastStatusChangeTimeStamp": "2020-01-01 12:02:44", "object": "vni-0/0", "org": "Tenant-2", "serialNum": "string", "severity": "string", "specific-problem": "string", "statusChanges": [ { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" }, { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" }, { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" } ], "type": "interface-down" } } } } }, "parameters": [ { "name": "alarmHandlings0AssignedBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0Description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0State", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0Time", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0User", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceGroup", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "isCleared", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastAlarmText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastPerceivedSeverity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastStatusChangeTimeStamp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "object", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serial", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0AlarmText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0EventTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0ReceivedTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0Severity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnms/fault/alarm/object/purge": { "post": { "tags": [ "Alarms" ], "operationId": "purgeAlarmObject", "description": "The parameters and request body are for method: purgeAlarmObject. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alarmHandlings0AssignedBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0Description", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0State", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0Time", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "alarmHandlings0User", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceGroup", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "isCleared", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastAlarmText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastPerceivedSeverity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lastStatusChangeTimeStamp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "object", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "serial", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "severity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0AlarmText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0EventTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0ReceivedTime", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusChanges0Severity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnms/fault/alarm/purge": { "delete": { "tags": [ "Alarms" ], "operationId": "purgeAlarm", "description": "The parameters and request body are for method: purgeAlarm. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "managedObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/vnms/fault/alarm/status": { "get": { "tags": [ "Alarms" ], "operationId": "getStatusChange", "description": "The parameters and request body are for method: getStatusChange. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "alarmHandlings": { "type": "array", "items": { "type": "object", "properties": { "assignedBy": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "time": { "type": "string" }, "user": { "type": "string" } } } }, "device": { "type": "string" }, "deviceGroup": { "type": "string" }, "deviceName": { "type": "string" }, "isCleared": { "type": "string" }, "lastAlarmText": { "type": "string" }, "lastPerceivedSeverity": { "type": "string" }, "lastStatusChangeTimeStamp": { "type": "string" }, "object": { "type": "string" }, "org": { "type": "string" }, "serialNum": { "type": "string" }, "severity": { "type": "string" }, "specific-problem": { "type": "string" }, "statusChanges": { "type": "array", "items": { "type": "object", "properties": { "alarmText": { "type": "string" }, "eventTime": { "type": "string" }, "receivedTime": { "type": "string" }, "severity": { "type": "string" } } } }, "type": { "type": "string" } } }, "example": { "alarmHandlings": [ { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" } ], "device": "SDWAN-Branch2", "deviceGroup": "San-Jose-DG", "deviceName": "SDWAN-Branch2", "isCleared": "true", "lastAlarmText": "CPU usage on appliance R2Controller exceeded hard limit", "lastPerceivedSeverity": "critical", "lastStatusChangeTimeStamp": "2020-01-01 12:02:44", "object": "vni-0/0", "org": "Tenant-2", "serialNum": "string", "severity": "string", "specific-problem": "string", "statusChanges": [ { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" }, { "alarmText": "string", "eventTime": "2020-04-08 00:28:42", "receivedTime": "2020-04-08 00:29:12.8594", "severity": "major" } ], "type": "interface-down" } } } } }, "parameters": [ { "name": "deviceName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "managedObject", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "org", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "specificProblem", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Alarms" ], "operationId": "getStatusChangeObject", "description": "The parameters and request body are for method: getStatusChangeObject. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "alarmHandlings": { "type": "array", "items": { "type": "object", "properties": { "assignedBy": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" }, "time": { "type": "string" }, "user": { "type": "string" } } } }, "device": { "type": "string" }, "deviceGroup": { "type": "string" }, "deviceName": { "type": "string" }, "isCleared": { "type": "string" }, "lastAlarmText": { "type": "string" }, "lastPerceivedSeverity": { "type": "string" }, "lastStatusChangeTimeStamp": { "type": "string" }, "object": { "type": "string" }, "org": { "type": "string" }, "serialNum": { "type": "string" }, "severity": { "type": "string" }, "specific-problem": { "type": "string" }, "statusChanges": { "type": "array", "items": { "type": "object", "properties": { "alarmText": { "type": "string" }, "eventTime": { "type": "string" }, "receivedTime": { "type": "string" }, "severity": { "type": "string" } } } }, "type": { "type": "string" } } }, "example": { "alarmHandlings": [ { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }, { "assignedBy": "ConsoleOperator", "description": "Administrator", "state": "closed", "time": "2020-04-13 09:16:02.986123", "user": "assigned" }