API docs by Redocly

SNMP Service (4.0.2)

Download OpenAPI specification:

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.

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

Specify the hostname or IPv4/IPv6 address 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
required

Register a new trap subscriber for SNMP messages.

type
required
string
host
required
string
v2community
string
v3user
string
v3authprotocol
string
Enum: "md5" "sha1"

Authentication protocol associated with user

v3authpassword
string
v3privprotocol
string
Enum: "aes" "des"

Privacy protocol associated with username

v3privpassword
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "host": "string",
  • "v2community": "string",
  • "v3user": "string",
  • "v3authprotocol": "md5",
  • "v3authpassword": "string",
  • "v3privprotocol": "aes",
  • "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.000+00:00",
  • "end_time": "2000-01-23T04:56:07.000+00:00",
  • "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"
}