Documentation Powered by ReDoc

FaultManager Service (3.2.0)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: https://www.extremenetworks.com License: Apache license

This is the spec that defines the APIs provided by the Fault Manager service to raise alerts and alarms

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Health

getHealth

Get the health of the faultmanager service

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "Service": "string",
  • "MessageBus": "string"
}

Alerts

getAlertInventory

Pre-generated lists of all possible alerts that EFA could raise

Authorizations:
bearerAuth
query Parameters
alert_id
integer

ID identifying EFA alert

resource
string

Health resource path associated to the alert being sent

Responses

Response samples

Content type
application/json
{
  • "Alerts": [
    ]
}

getAlertHistory

Actual history of alerts generated by EFA

Authorizations:
bearerAuth
query Parameters
alert_id
integer

ID identifying EFA alert

severity
string
Enum: "Critical" "Major" "Minor" "Warning" "Info"

Severity of EFA alert

sequence_id
integer

Tracks the sequence in which messages are submitted

resource
string

Health resource path associated to the alert being sent

limit
integer

Limit the number of alerts to be displayed

before_timestamp
string

Alerts being sent before a particular time stamp

after_timestamp
string

Alerts being sent after a particular time stamp

object

{"sort_by":"asc|desc"} Responses with sequence id in ascending or descending order {"offset" : "lt:30"} Responses searched with sequence id less than 30 {"page_size":20} Responses searched with limit of 20 entries

Responses

Response samples

Content type
application/json
{
  • "Alerts": [
    ]
}

clearAlertHistory

clear all alerts in history

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "result": 0,
  • "error": "Unknown error"
}

Alarms

getAlarmInventory

Pre-generated lists of all possible alarms that EFA could raise

Authorizations:
bearerAuth
query Parameters
alarm_id
integer

Global ID identifying EFA alarm

name
string

Name identifying EFA alarm

resource
string

Resource identifying EFA alarm

alarm_type
string

Type of alarm

detail
booolean

Display detailed information

Responses

Response samples

Content type
application/json
{
  • "Alarms": [
    ]
}

getAlarmHistory

Actual history of alarms generated by EFA

Authorizations:
bearerAuth
query Parameters
name
string

Name of EFA alarm

alarm_id
integer

Global ID identifying EFA alarm

alarm_type
string

Category of EFA alarm

instance_id
integer

Instance ID of the alarm

resource
string

Health resource path associated to the alarm being sent

unacked
boolean

List of unacked alarms

acked
boolean

List of acked alarms

cleared
boolean

List of cleared alarms

closed
boolean

List of closed alarms

detail
booolean

Display detailed information

object

{"sort_by":"asc|desc"} Responses with sequence id in ascending or descending order {"offset" : "lt:30"} Responses searched with sequence id less than 30 {"page_size":20} Responses searched with limit of 20 entries

Responses

Response samples

Content type
application/json
{
  • "Alarms": [
    ]
}

acknowledgeAlarm

acknowledge raised alarm

Authorizations:
bearerAuth
query Parameters
instance_id
integer

Instance ID identifying EFA alarm

resource
string

Resource associated with EFA alarm

comment
string

Comment that needs to updated on the Alarm

Responses

Response samples

Content type
application/json
{
  • "Name": "Certificate expiry notice alarm",
  • "AlarmID": 32000,
  • "InstanceID": 2,
  • "AlarmType": "Security",
  • "Resource": "/App/System/Security/Certificate",
  • "Severity": "Warning",
  • "IsCleared": false,
  • "Message": "Authentication failed for user extreme",
  • "TimeCreated": "2022-09-22T10:06:01.000Z",
  • "LastRaised": "2022-09-22T14:06:01.000Z",
  • "LastChanged": "2022-09-22T14:06:01.000Z",
  • "IsAcked": false,
  • "IsClosed": false,
  • "StatusChangeList": [
    ],
  • "UserStateChangeList": [
    ]
}

closeAlarm

close raised or cleared alarm

Authorizations:
bearerAuth
query Parameters
instance_id
integer

Instance ID identifying EFA alarm

resource
string

Resource associated with EFA alarm

comment
string

Comment that needs to updated on the Alarm

Responses

Response samples

Content type
application/json
{
  • "Name": "Certificate expiry notice alarm",
  • "AlarmID": 32000,
  • "InstanceID": 2,
  • "AlarmType": "Security",
  • "Resource": "/App/System/Security/Certificate",
  • "Severity": "Warning",
  • "IsCleared": false,
  • "Message": "Authentication failed for user extreme",
  • "TimeCreated": "2022-09-22T10:06:01.000Z",
  • "LastRaised": "2022-09-22T14:06:01.000Z",
  • "LastChanged": "2022-09-22T14:06:01.000Z",
  • "IsAcked": false,
  • "IsClosed": false,
  • "StatusChangeList": [
    ],
  • "UserStateChangeList": [
    ]
}

alarmSummary

Alarm Summary

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "Alarms": [
    ]
}

alarmPurge

Purges all closed alarms in XCO

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "Message": "All closed alarms are purged succesfully"
}