NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Protocol Settings

Description

Enables fetching, adding, updating, or deleting protocol setting data. Available protocols to update are: SSH, HTTP, SNMP, and SNMPv3. Users can update credentials data for two objects: Systems and Groups

Request URL

/neo/app/settings/device_access

Main Operations

  • Add new settings

  • Update settings

  • Delete settings

  • Get settings of a specifie

Warning

Only one active SNMP protocol can be added at a time.

Description

Adds new setting data, either for systems or for global groups in NEO

Request URL

POST /neo/app/settings/device_access/settings

Response

HTTP Response location header will contain URI with Job ID created for adding new settings: /neo/app/jobs/<job_ID>

Status Codes

Note: status code 409 CONFLICT means that Access Credentials already exist for the specified object

Request Data:

Copy
Copied!
            

{ object: "10.224.14.8.system", protocol: "snmp", "port": 161, "retries": 2, "timeout": 2, "active": true }

Description

Updates existing setting data, either for systems or for global groups in NEO

Request URL

PUT /neo/app/settings/device_access/settings

Response

HTTP Response location header will contain URI with Job ID created for adding new settings: /neo/app/jobs/<job_ID>

Request Data:

Copy
Copied!
            

{ object: "10.224.14.8.system", protocol: "snmp", "port": 161, "retries": 2, "timeout": 2  }

Description

Deletes existing credentials data, either for systems or for groups (custom groups or global groups) in NEO

Request URL

DELETE /neo/app/settings/device_access/settings/<object_id>/<protocol>

Request Data

N/A

Response

HTTP Response location header will contain URI with Job ID created for adding new settings: /neo/app/jobs/<job_ID>

Description

Retrieves setting data for a system or for a global group in NEO

Request URL

GET /neo/app/settings/device_access/settings/<object_id>/<protocol>

Request Data

N/A

Response:

Copy
Copied!
            

{ "active": true, "retries": 7, "port": 161, "timeout": 2, "inherited": null }

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.