Documentation Powered by ReDoc

SNMP Service (3.1.0)

Download OpenAPI specification:Download

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

This is the spec that defines the API provided by the SNMP Service.

Authentication

bearerAuth

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

Subscriber

getTrapSubscribers

Get all the trap subscribers from the SNMP service.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

deleteTrapSubscriber

Delete the specified trap subscriber from the SNMP service.

Authorizations:
bearerAuth
path Parameters
host
required
string

Host (IP or hostname) of the trap subscriber entry to be deleted.

Responses

Response samples

Content type
application/json
{
  • "message": "Subscriber is not found.",
  • "code": 101
}

Register

registerTrapSubscriber

Register trap subscriber with the SNMP service.

Authorizations:
bearerAuth
Request Body schema: application/json

Register a new trap subscriber for SNMP messages.

id
required
integer
type
required
string
host
required
string
v2community
string
v3user
string
v3authprotocol
string
v3authpassword
string
v3privprotocol
string
v3privpassword
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "host": "string",
  • "v2community": "string",
  • "v3user": "string",
  • "v3authprotocol": "string",
  • "v3authpassword": "string",
  • "v3privprotocol": "string",
  • "v3privpassword": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "host": "string",
  • "v2community": "string",
  • "v3user": "string",
  • "v3authprotocol": "string",
  • "v3authpassword": "string",
  • "v3privprotocol": "string",
  • "v3privpassword": "string"
}

Trouble Shooting

getExecutionDetail

Get the detailed output of a request previously executed, based on a given request ID.

Authorizations:
bearerAuth
query Parameters
id
required
string

Detailed output of a request previously executed, based on a given request ID.

Responses

Response samples

Content type
application/json
{
  • "start_time": "2000-01-23T04:56:07.000Z",
  • "end_time": "2000-01-23T04:56:07.000Z",
  • "id": "id",
  • "parameters": "host=10.0.0.2",
  • "logs": "logs",
  • "command": "subscriber add",
  • "status": "Failed, Succeeded"
}

getExecutionList

Get the list of all the requests previously executed.

Authorizations:
bearerAuth
query Parameters
limit
required
integer
Default: 10

Limit the number of executions that will be sent in the response. Default is 10

status
string
Default: "all"

Filter the executions based on the status (failed/succeeded/all).

Responses

Response samples

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

Health

getHealth

Get the health of the RASlog service.

Authorizations:
bearerAuth

Responses

Response samples

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