@itentialopensource/adapter-versa_director

{ "swagger" : "2.0", "info" : { "description" : "Versa Director API", "version" : "1.0", "title" : "Versa Director API", "contact" : { "name" : "Versa Networks, INC", "url" : "https://support.versa-networks.com/support/login", "email" : "support@versa-networks.com" } }, "basePath" : "/", "tags" : [ { "name" : "Alarms", "description" : "Alarm Service Controller" } ], "schemes" : [ "https" ], "paths" : { "/vnms/fault/alarm/assign" : { "post" : { "tags" : [ "Alarms" ], "summary" : "Assign an alarm", "description" : "Assign an alarm to a user", "operationId" : "assignAlarmObjectUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "name" : "alarm", "in" : "query", "description" : "alarm", "required" : false, "type" : "string" }, { "name" : "assignee", "in" : "query", "description" : "Username of assignee", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "description", "in" : "query", "description" : "Description of the handling action", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "state", "in" : "query", "description" : "New handling state", "required" : true, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false }, "put" : { "tags" : [ "Alarms" ], "summary" : "Assign an alarm", "description" : "Assign an alarm to a user", "operationId" : "assignAlarmUsingPUT", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "name" : "assignee", "in" : "query", "description" : "Username of assignee", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "description", "in" : "query", "description" : "Description of the handling action", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "deviceName", "in" : "query", "description" : "Device name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "managedObject", "in" : "query", "description" : "Managed object of alarm", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "specific-problem", "in" : "query", "description" : "Specific problem that caused alarm (optional)", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "state", "in" : "query", "description" : "New handling state", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : true, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarm/clear" : { "post" : { "tags" : [ "Alarms" ], "summary" : "Clear an alarm", "description" : "Clearm with given parameters", "operationId" : "clearAlarmUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "name" : "deviceName", "in" : "query", "description" : "Device name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "managedObject", "in" : "query", "description" : "Managed object of alarm", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "specific-problem", "in" : "query", "description" : "Specific problem that caused alarm (optional)", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : true, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarm/handle" : { "post" : { "tags" : [ "Alarms" ], "summary" : "Handle an alarm", "description" : "Handle an alarm", "operationId" : "handleAlarmObjectUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "name" : "alarm.alarmHandlings[0].assignedBy", "in" : "query", "description" : "The person doing the assignment", "required" : false, "type" : "string", "x-example" : "ConsoleOperator" }, { "name" : "alarm.alarmHandlings[0].description", "in" : "query", "description" : "Description of the handling/assignment", "required" : false, "type" : "string", "x-example" : "Administrator" }, { "name" : "alarm.alarmHandlings[0].state", "in" : "query", "description" : "New handling state", "required" : false, "type" : "string", "x-example" : "closed" }, { "name" : "alarm.alarmHandlings[0].time", "in" : "query", "description" : "When handling/assignement happened", "required" : false, "type" : "string", "x-example" : "2020-04-13 09:16:02.986123" }, { "name" : "alarm.alarmHandlings[0].user", "in" : "query", "description" : "The person alarm was assigned to", "required" : false, "type" : "string", "x-example" : "assigned" }, { "name" : "alarm.device", "in" : "query", "description" : "Device name", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "alarm.deviceGroup", "in" : "query", "description" : "Device group", "required" : false, "type" : "string", "x-example" : "San-Jose-DG" }, { "name" : "alarm.deviceName", "in" : "query", "description" : "Device name where alarm comes from", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "alarm.isCleared", "in" : "query", "description" : "Whether the alarm has been cleared", "required" : false, "type" : "string", "x-example" : "true" }, { "name" : "alarm.lastAlarmText", "in" : "query", "description" : "Alarm description if any", "required" : false, "type" : "string", "x-example" : "CPU usage on appliance R2Controller exceeded hard limit" }, { "name" : "alarm.lastPerceivedSeverity", "in" : "query", "description" : "Current severity of the alarm", "required" : false, "type" : "string", "x-example" : "critical" }, { "name" : "alarm.lastStatusChangeTimeStamp", "in" : "query", "description" : "Last time an instance of this alarm came", "required" : false, "type" : "string", "format" : "date-time", "x-example" : "2020-01-01 12:02:44" }, { "name" : "alarm.object", "in" : "query", "description" : "The particular object that generated the alarm", "required" : false, "type" : "string", "x-example" : "vni-0/0" }, { "name" : "alarm.org", "in" : "query", "description" : "Tenant name", "required" : false, "type" : "string", "x-example" : "Tenant-2" }, { "name" : "alarm.serial", "in" : "query", "description" : "Serial number", "required" : false, "type" : "string" }, { "name" : "alarm.severity", "in" : "query", "required" : false, "type" : "string" }, { "name" : "alarm.statusChanges[0].alarmText", "in" : "query", "description" : "Alarm text", "required" : false, "type" : "string" }, { "name" : "alarm.statusChanges[0].eventTime", "in" : "query", "description" : "When the alarm was generated", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:28:42" }, { "name" : "alarm.statusChanges[0].receivedTime", "in" : "query", "description" : "When the alarm was received by director", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:29:12.8594" }, { "name" : "alarm.statusChanges[0].severity", "in" : "query", "description" : "Severity of the alarm when it was received", "required" : false, "type" : "string", "x-example" : "major" }, { "name" : "alarm.type", "in" : "query", "description" : "Alarm type", "required" : false, "type" : "string", "x-example" : "interface-down" }, { "name" : "assignee", "in" : "query", "description" : "Assignee", "required" : false, "type" : "string" }, { "name" : "description", "in" : "query", "description" : "Description of handling action", "required" : false, "type" : "string" }, { "name" : "specific-problem", "in" : "query", "description" : "Specific reason for the alarm", "required" : false, "type" : "string" }, { "name" : "state", "in" : "query", "description" : "New handling state", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "object" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false }, "put" : { "tags" : [ "Alarms" ], "summary" : "Handle an alarm", "description" : "Handle an alarm", "operationId" : "handleAlarmUsingPUT", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "name" : "description", "in" : "query", "description" : "Description of the handling action", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "deviceName", "in" : "query", "description" : "Device name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "managedObject", "in" : "query", "description" : "Managed object of alarm", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "specific-problem", "in" : "query", "description" : "Specific problem that caused alarm (optional)", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "state", "in" : "query", "description" : "New handling state", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : true, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarm/handling" : { "get" : { "tags" : [ "Alarms" ], "summary" : "Retrieve handlings associated with an alarm", "description" : "Retrieve handlings associated with an alarm", "operationId" : "getAlarmHandlingUsingGET", "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceName", "in" : "query", "description" : "Device name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "managedObject", "in" : "query", "description" : "Managed object of alarm", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "specific-problem", "in" : "query", "description" : "Specific problem that caused alarm (optional)", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : true, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "Returns the handlings encapsulated in an alarm object", "schema" : { "$ref" : "#/definitions/Alarm" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false }, "post" : { "tags" : [ "Alarms" ], "summary" : "Retrieve handlings associated with an alarm", "description" : "Retrieve handlings associated with an alarm", "operationId" : "getAlarmHandlingObjectUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "alarmHandlings[0].assignedBy", "in" : "query", "description" : "The person doing the assignment", "required" : false, "type" : "string", "x-example" : "ConsoleOperator" }, { "name" : "alarmHandlings[0].description", "in" : "query", "description" : "Description of the handling/assignment", "required" : false, "type" : "string", "x-example" : "Administrator" }, { "name" : "alarmHandlings[0].state", "in" : "query", "description" : "New handling state", "required" : false, "type" : "string", "x-example" : "closed" }, { "name" : "alarmHandlings[0].time", "in" : "query", "description" : "When handling/assignement happened", "required" : false, "type" : "string", "x-example" : "2020-04-13 09:16:02.986123" }, { "name" : "alarmHandlings[0].user", "in" : "query", "description" : "The person alarm was assigned to", "required" : false, "type" : "string", "x-example" : "assigned" }, { "name" : "device", "in" : "query", "description" : "Device name", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "deviceGroup", "in" : "query", "description" : "Device group", "required" : false, "type" : "string", "x-example" : "San-Jose-DG" }, { "name" : "deviceName", "in" : "query", "description" : "Device name where alarm comes from", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "isCleared", "in" : "query", "description" : "Whether the alarm has been cleared", "required" : false, "type" : "string", "x-example" : "true" }, { "name" : "lastAlarmText", "in" : "query", "description" : "Alarm description if any", "required" : false, "type" : "string", "x-example" : "CPU usage on appliance R2Controller exceeded hard limit" }, { "name" : "lastPerceivedSeverity", "in" : "query", "description" : "Current severity of the alarm", "required" : false, "type" : "string", "x-example" : "critical" }, { "name" : "lastStatusChangeTimeStamp", "in" : "query", "description" : "Last time an instance of this alarm came", "required" : false, "type" : "string", "format" : "date-time", "x-example" : "2020-01-01 12:02:44" }, { "name" : "object", "in" : "query", "description" : "The particular object that generated the alarm", "required" : false, "type" : "string", "x-example" : "vni-0/0" }, { "name" : "org", "in" : "query", "description" : "Tenant name", "required" : false, "type" : "string", "x-example" : "Tenant-2" }, { "name" : "serial", "in" : "query", "description" : "Serial number", "required" : false, "type" : "string" }, { "name" : "severity", "in" : "query", "required" : false, "type" : "string" }, { "name" : "specific-problem", "in" : "query", "description" : "Specific reason for the alarm", "required" : false, "type" : "string" }, { "name" : "statusChanges[0].alarmText", "in" : "query", "description" : "Alarm text", "required" : false, "type" : "string" }, { "name" : "statusChanges[0].eventTime", "in" : "query", "description" : "When the alarm was generated", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:28:42" }, { "name" : "statusChanges[0].receivedTime", "in" : "query", "description" : "When the alarm was received by director", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:29:12.8594" }, { "name" : "statusChanges[0].severity", "in" : "query", "description" : "Severity of the alarm when it was received", "required" : false, "type" : "string", "x-example" : "major" }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : false, "type" : "string", "x-example" : "interface-down" } ], "responses" : { "200" : { "description" : "Returns the handlings encapsulated in an alarm object", "schema" : { "$ref" : "#/definitions/Alarm" } }, "201" : { "description" : "Created" }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarm/object/purge" : { "post" : { "tags" : [ "Alarms" ], "summary" : "purgeAlarmObject", "operationId" : "purgeAlarmObjectUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "alarmHandlings[0].assignedBy", "in" : "query", "description" : "The person doing the assignment", "required" : false, "type" : "string", "x-example" : "ConsoleOperator" }, { "name" : "alarmHandlings[0].description", "in" : "query", "description" : "Description of the handling/assignment", "required" : false, "type" : "string", "x-example" : "Administrator" }, { "name" : "alarmHandlings[0].state", "in" : "query", "description" : "New handling state", "required" : false, "type" : "string", "x-example" : "closed" }, { "name" : "alarmHandlings[0].time", "in" : "query", "description" : "When handling/assignement happened", "required" : false, "type" : "string", "x-example" : "2020-04-13 09:16:02.986123" }, { "name" : "alarmHandlings[0].user", "in" : "query", "description" : "The person alarm was assigned to", "required" : false, "type" : "string", "x-example" : "assigned" }, { "name" : "device", "in" : "query", "description" : "Device name", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "deviceGroup", "in" : "query", "description" : "Device group", "required" : false, "type" : "string", "x-example" : "San-Jose-DG" }, { "name" : "deviceName", "in" : "query", "description" : "Device name where alarm comes from", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "isCleared", "in" : "query", "description" : "Whether the alarm has been cleared", "required" : false, "type" : "string", "x-example" : "true" }, { "name" : "lastAlarmText", "in" : "query", "description" : "Alarm description if any", "required" : false, "type" : "string", "x-example" : "CPU usage on appliance R2Controller exceeded hard limit" }, { "name" : "lastPerceivedSeverity", "in" : "query", "description" : "Current severity of the alarm", "required" : false, "type" : "string", "x-example" : "critical" }, { "name" : "lastStatusChangeTimeStamp", "in" : "query", "description" : "Last time an instance of this alarm came", "required" : false, "type" : "string", "format" : "date-time", "x-example" : "2020-01-01 12:02:44" }, { "name" : "object", "in" : "query", "description" : "The particular object that generated the alarm", "required" : false, "type" : "string", "x-example" : "vni-0/0" }, { "name" : "org", "in" : "query", "description" : "Tenant name", "required" : false, "type" : "string", "x-example" : "Tenant-2" }, { "name" : "serial", "in" : "query", "description" : "Serial number", "required" : false, "type" : "string" }, { "name" : "severity", "in" : "query", "required" : false, "type" : "string" }, { "name" : "specific-problem", "in" : "query", "description" : "Specific reason for the alarm", "required" : false, "type" : "string" }, { "name" : "statusChanges[0].alarmText", "in" : "query", "description" : "Alarm text", "required" : false, "type" : "string" }, { "name" : "statusChanges[0].eventTime", "in" : "query", "description" : "When the alarm was generated", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:28:42" }, { "name" : "statusChanges[0].receivedTime", "in" : "query", "description" : "When the alarm was received by director", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:29:12.8594" }, { "name" : "statusChanges[0].severity", "in" : "query", "description" : "Severity of the alarm when it was received", "required" : false, "type" : "string", "x-example" : "major" }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : false, "type" : "string", "x-example" : "interface-down" } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : true } }, "/vnms/fault/alarm/purge" : { "delete" : { "tags" : [ "Alarms" ], "summary" : "purgeAlarm", "operationId" : "purgeAlarmUsingDELETE", "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceName", "in" : "query", "description" : "deviceName", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "managedObject", "in" : "query", "description" : "managedObject", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "org", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "specific-problem", "in" : "query", "description" : "specific-problem", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "type", "required" : false, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "204" : { "description" : "No Content" }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : true } }, "/vnms/fault/alarm/status" : { "get" : { "tags" : [ "Alarms" ], "summary" : "Retrieve status changes associated with an alarm", "description" : "Retrieve status changes associated with an alarm", "operationId" : "getStatusChangeUsingGET", "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceName", "in" : "query", "description" : "Device name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "managedObject", "in" : "query", "description" : "Managed object of alarm", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "specific-problem", "in" : "query", "description" : "Specific problem that caused alarm (optional)", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : true, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "Returns the status changes encapsulated in an alarm object", "schema" : { "$ref" : "#/definitions/Alarm" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false }, "post" : { "tags" : [ "Alarms" ], "summary" : "Retrieve status changes associated with an alarm", "description" : "Retrieve status changes associated with an alarm", "operationId" : "getStatusChangeObjectUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "alarmHandlings[0].assignedBy", "in" : "query", "description" : "The person doing the assignment", "required" : false, "type" : "string", "x-example" : "ConsoleOperator" }, { "name" : "alarmHandlings[0].description", "in" : "query", "description" : "Description of the handling/assignment", "required" : false, "type" : "string", "x-example" : "Administrator" }, { "name" : "alarmHandlings[0].state", "in" : "query", "description" : "New handling state", "required" : false, "type" : "string", "x-example" : "closed" }, { "name" : "alarmHandlings[0].time", "in" : "query", "description" : "When handling/assignement happened", "required" : false, "type" : "string", "x-example" : "2020-04-13 09:16:02.986123" }, { "name" : "alarmHandlings[0].user", "in" : "query", "description" : "The person alarm was assigned to", "required" : false, "type" : "string", "x-example" : "assigned" }, { "name" : "device", "in" : "query", "description" : "Device name", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "deviceGroup", "in" : "query", "description" : "Device group", "required" : false, "type" : "string", "x-example" : "San-Jose-DG" }, { "name" : "deviceName", "in" : "query", "description" : "Device name where alarm comes from", "required" : false, "type" : "string", "x-example" : "SDWAN-Branch2" }, { "name" : "isCleared", "in" : "query", "description" : "Whether the alarm has been cleared", "required" : false, "type" : "string", "x-example" : "true" }, { "name" : "lastAlarmText", "in" : "query", "description" : "Alarm description if any", "required" : false, "type" : "string", "x-example" : "CPU usage on appliance R2Controller exceeded hard limit" }, { "name" : "lastPerceivedSeverity", "in" : "query", "description" : "Current severity of the alarm", "required" : false, "type" : "string", "x-example" : "critical" }, { "name" : "lastStatusChangeTimeStamp", "in" : "query", "description" : "Last time an instance of this alarm came", "required" : false, "type" : "string", "format" : "date-time", "x-example" : "2020-01-01 12:02:44" }, { "name" : "object", "in" : "query", "description" : "The particular object that generated the alarm", "required" : false, "type" : "string", "x-example" : "vni-0/0" }, { "name" : "org", "in" : "query", "description" : "Tenant name", "required" : false, "type" : "string", "x-example" : "Tenant-2" }, { "name" : "serial", "in" : "query", "description" : "Serial number", "required" : false, "type" : "string" }, { "name" : "severity", "in" : "query", "required" : false, "type" : "string" }, { "name" : "specific-problem", "in" : "query", "description" : "Specific reason for the alarm", "required" : false, "type" : "string" }, { "name" : "statusChanges[0].alarmText", "in" : "query", "description" : "Alarm text", "required" : false, "type" : "string" }, { "name" : "statusChanges[0].eventTime", "in" : "query", "description" : "When the alarm was generated", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:28:42" }, { "name" : "statusChanges[0].receivedTime", "in" : "query", "description" : "When the alarm was received by director", "required" : false, "type" : "string", "x-example" : "2020-04-08 00:29:12.8594" }, { "name" : "statusChanges[0].severity", "in" : "query", "description" : "Severity of the alarm when it was received", "required" : false, "type" : "string", "x-example" : "major" }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : false, "type" : "string", "x-example" : "interface-down" } ], "responses" : { "200" : { "description" : "Returns the status changes encapsulated in an alarm object", "schema" : { "$ref" : "#/definitions/Alarm" } }, "201" : { "description" : "Created" }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarms" : { "get" : { "tags" : [ "Alarms" ], "summary" : "Retrieve alarms satisfying certain conditions", "description" : "Retrieve all alarms matching a set of given parameters", "operationId" : "getAllFilteredAlarmsUsingGET", "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceName", "in" : "query", "description" : "Device name, wild card (*) is accepted", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "filtertype", "in" : "query", "description" : "How the different conditions are combined ('and' or 'or')", "required" : false, "type" : "string", "default" : "or", "allowEmptyValue" : false }, { "name" : "isCleared", "in" : "query", "description" : "Whether to return cleared or uncleared alarms only", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "isDeep", "in" : "query", "description" : "Whether return should contain notification trail or not. Default value is false.", "required" : false, "type" : "string", "default" : "false", "allowEmptyValue" : false }, { "name" : "lastAlarmText", "in" : "query", "description" : "Alarm text, wild card (*) is accepted", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "lastPerceivedSeverity", "in" : "query", "description" : "Current alarm severity", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "lastStatusChange", "in" : "query", "description" : "When last status change happened", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : false, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "Returns the list of alarm objects", "schema" : { "$ref" : "#/definitions/AlarmList" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarms/assign" : { "put" : { "tags" : [ "Alarms" ], "summary" : "Bulk assign alarms matching certain conditions", "description" : "Bulk assign alarms matching conditions provided by optional parameters", "operationId" : "assignAllFilteredAlarmsUsingPUT", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "name" : "assignee", "in" : "query", "description" : "Username of new assignee", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "description", "in" : "query", "description" : "Description of the handling action", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "deviceName", "in" : "query", "description" : "Device name, wild card (*) is accepted", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "filtertype", "in" : "query", "description" : "How the different conditions are combined ('and' or 'or')", "required" : false, "type" : "string", "default" : "or", "allowEmptyValue" : false }, { "name" : "isCleared", "in" : "query", "description" : "Whether to return cleared or uncleared alarms only", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "lastAlarmText", "in" : "query", "description" : "Alarm text, wild card (*) is accepted", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "lastPerceivedSeverity", "in" : "query", "description" : "Current alarm severity", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "lastStatusChange", "in" : "query", "description" : "When last status change happened", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "org", "in" : "query", "description" : "Organization name", "required" : false, "type" : "string", "allowEmptyValue" : false }, { "name" : "state", "in" : "query", "description" : "New handling state", "required" : true, "type" : "string", "allowEmptyValue" : false }, { "name" : "type", "in" : "query", "description" : "Alarm type", "required" : false, "type" : "string", "allowEmptyValue" : false } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarms/bulk/assign" : { "post" : { "tags" : [ "Alarms" ], "summary" : "Bulk assign a list of specific alarms", "description" : "Bulk assign a list of specific alarms", "operationId" : "assignAllAlarmsUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "in" : "body", "name" : "alarmData", "description" : "alarmData", "required" : true, "schema" : { "$ref" : "#/definitions/BulkAlarmData" } } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/vnms/fault/alarms/bulk/clear" : { "post" : { "tags" : [ "Alarms" ], "summary" : "Bulk clear multiple alarms", "description" : "Bulk clear multiple alarms at the same time", "operationId" : "clearAllAlarmsUsingPOST", "consumes" : [ "application/json" ], "produces" : [ "application/json", "text/plain" ], "parameters" : [ { "in" : "body", "name" : "alarmData", "description" : "alarmData", "required" : true, "schema" : { "$ref" : "#/definitions/BulkAlarmData" } } ], "responses" : { "200" : { "description" : "OK", "schema" : { "type" : "object" } }, "201" : { "description" : "Created" }, "204" : { "description" : "(empty string)", "schema" : { "type" : "string" } }, "401" : { "description" : "Unauthorized" }, "403" : { "description" : "Forbidden" }, "404" : { "description" : "Not Found" } }, "security" : [ { "oauth2schema" : [ "global" ] }, { } ], "deprecated" : false } }, "/v