SNMP Configuration



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/snmp-config

Summary


Resources Methods
https://localhost:8443/api/rest/snmp-config

GET  [tags: DMA,RPRM] Retrieves an object that contains the snmp configuration including enabled or not, SNMP V2 or V3, security users and notification agents that have been defined.

PUT  [tags: DMA,RPRM] sends a new snmp configuraion to the system, validate it, store it and implement it.

https://localhost:8443/api/rest/snmp-config/mibs

GET  [tags: DMA] Retrieves a list of the Polycom MIB filenames.

https://localhost:8443/api/rest/snmp-config/mibs/{mib-filename}

GET  [tags: DMA] Download a specific Polycom MIB.

Resources


https://localhost:8443/api/rest/snmp-config


Methods

GET


[tags: DMA,RPRM]
Retrieves an object that contains the snmp configuration including enabled or not, SNMP V2 or V3, security users and notification agents that have been defined.

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-snmp-config+xml
application/vnd.plcm.plcm-snmp-config+json
application/vnd.plcm.plcm-snmp-config-v2+xml
application/vnd.plcm.plcm-snmp-config-v2+json
Snmp config information successfully retrieved.
Applied to RPRM, only the Representation of application/vnd.plcm.plcm-snmp-config+xml is implemented and can be accessed by setting Http Accept.
401 Authentication required
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Data read from storage location is invalid.
500 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Server Error. Failed to read from storage location

PUT


[tags: DMA,RPRM]
sends a new snmp configuraion to the system, validate it, store it and implement it. Stop and restart snmpd.

Request

Representations

application/vnd.plcm.plcm-snmp-config+xml
application/vnd.plcm.plcm-snmp-config+json
application/vnd.plcm.plcm-snmp-config-v2+xml
application/vnd.plcm.plcm-snmp-config-v2+json

Response

Status Representation Description
204 Snmp Configuration sucessfully updated
400 Provided object does not adhere to schema definition
401 Authentication required
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Something was wrong with the snmp config sent. More details will be in the response.
- Data was updated in another session
- A security user was specified for use without being defined in the security user list.
- A security user was defined twice in the security user list
- An internet address was improperly formatted
- An invalid port was specified
- Listening port is already in use
412 The object entity-tag is out-of-date. The object has changed since last GET
500 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Server Error.
- Snmpd service failed to stop or start
- Data storage error
- Failed verify current port usage

https://localhost:8443/api/rest/snmp-config/mibs


Methods

GET


[tags: DMA]
Retrieves a list of the Polycom MIB filenames. The DMA system MIB is self-documenting, including information about the purpose of specific traps and inform notifications.

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-mib-list+xml
application/vnd.plcm.plcm-mib-list+json
Polycom MIB filenames successfully retrieved.
304
Mib list information has not changed since the last search.

Note: The API client must provide the "plcm-mib-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-mib-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.
401 Authentication required
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator

https://localhost:8443/api/rest/snmp-config/mibs/{mib-filename}


Template Parameters

Name Type Description
mib-filename xs:string The filename of the MIB.

Methods

GET


[tags: DMA]
Download a specific Polycom MIB.

Request

Response

Status Representation Description
200 text/plain
Polycom MIB successfully downloaded.
401 Authentication required
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator