Documentation Powered by ReDoc

SNMP Service (2.6.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.

Subscriber

getTrapSubscribers

Get all the trap subscribers from the SNMP service.

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/subscribers
http://gosnmp-service:80/v1/snmp/subscribers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

deleteTrapSubscriber

Delete the specified trap subscriber from the SNMP service.

path Parameters
host
required
string

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

Responses

200

OK

401

Authorization information is missing or invalid.

404

A subscriber with the given subscriber host was not found.

500

Unexpected error.

default

Unexpected error.

delete/subscriber/{host}
http://gosnmp-service:80/v1/snmp/subscriber/{host}

Response samples

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

Register

registerTrapSubscriber

Register trap subscriber with the SNMP service.

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

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

post/subscribers
http://gosnmp-service:80/v1/snmp/subscribers

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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.

query Parameters
id
required
string

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

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/execution
http://gosnmp-service:80/v1/snmp/execution

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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.

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

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/executions
http://gosnmp-service:80/v1/snmp/executions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Health

getHealth

Get the health of the RASlog service.

Responses

200

OK

get/health
http://gosnmp-service:80/v1/snmp/health

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "Service": "string"
}