Telemetry Agent
|
Description |
Configures the server data where the data will be collected from all the Mellanox operating systems. |
Create Collector Data
|
Request URL |
POST /neo/app/telemetry/collector_data/ |
|
Request Data |
{ "address": < Collector_Data - IPV4 - Adress > , "port": < Collector_Data - Port - Number > } |
|
Response |
The HTTP response location header will contain an ID created for the new collector. |
|
Status Codes |
Note: For status code 400 see error details in the body |
Get Collector Data
|
Request URL |
GET /neo/app/telemetry/collector_data/<id> |
|
Response |
{ |
Get Available Collectors
|
Description |
Get available collectors for Telemetry. |
|
Request URL |
GET / neo/app/telemetry/available_collectors |
|
Request Data |
{ "allowed_collectors":[ <Collectors types>], "max_collectors": <Max collectors to add> } |
Get Supported Profile Sessions per Collector
|
Description |
Get supported profile sessions per collector. |
|
Request URL |
GET / neo/app/telemetry/supported_collectors |
|
Request Data |
{ <Collector name>: <Supported profile IDs} |
|
Description |
Configures telemetry sessions on a switch and starts the sessions for data transfer. |
Create Session
|
Description |
Creates a telemetry session. |
|
Request URL |
POST /neo/app/telemetry/session/ |
|
Request Data |
{ "collector-data-id":0 } |
|
Response |
The HTTP response location header will contain an ID created for the new collector |
|
Status Codes |
Note: For status code 400 see error details in the body |
|
Description |
Gets a telemetry session. |
|
Request URL |
GET /neo/app/telemetry/session/<session-id> |
|
Response |
{ "telemetry-protocol": "gRPC", "telemetry-profile-id": "0", "telemetry-sample-interval": 5, "telemetry-collector-id": 0 } |
Start Session
|
Description |
Starts a telemetry session. |
|
Request URL |
POST neo/app/telemetry/session/<session>/start |
|
Request |
{ "object_ids": "system_ips"], "object_type": "System" } |
|
Response |
{ "location": "/neo/app/jobs/job_id", "objectID": "job_id" } |
Stop Session
|
Description |
Stops a telemetry session. |
|
Request URL |
POST /neo/app/telemetry/session/<session-id>/stop |
|
Request |
{ |
|
Response |
{ |
|
Status Codes |
Note: For status code 400 see error details in the body |
Get Session Members
|
Description |
Retrieves session members. |
|
Request URL |
GET /neo/app/telemetry/session/<session-id>/members |
|
Response |
[ { "errorMessages": [ { "severity": "Warning", "message": "Agent communication error" } ], "ip": "10.209.37.182", "status": "Warning", "lastSample": "2020-07-23 16:04:45", "requiresRecirculation": true, "recirculationPort": "Eth1/1" } ] |
Edit Collectors to an Existing Telemetry Session
|
Description |
Edit collectors to an existing telemetry session. |
|
Request URL |
POST /neo/app/telemetry/session/<sessions_id>/collectors |
Upgrade Telemetry Agent
|
Description |
Get supported profile sessions per collector |
|
Request URL |
POST /neo/actions/telemetry_agent/upgrade |
|
Request |
{ "object_ids:" "system_ips"], "object_type": "System" } |
|
Response |
{ "location": "/neo/app/jobs/job_id", "objectID": "job_id" } |
|
Status Codes |
Note: For status code 400 see error details in the body |