SNMP Configuration

Resource Root

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

Summary

Resources

Methods

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

GET    Retrieves the current SNMP configuration, such as SNMP version (v2c/v3), transport (UDP/TCP), port, authentication and encryption methods (MD5/SHA and DES/AES, respectively), etc.

PUT    Updates the SNMP configuration.

 

 

 

Resources

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

Methods

GET

Retrieves the current SNMP configuration, such as SNMP version (v2c/v3), transport (UDP/TCP), port, authentication and encryption methods (MD5/SHA and DES/AES, respectively), etc.

 

Response

Status

Representation

Description

200

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

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

SNMP configuration successfully retrieved.

401

 

Authentication required.

403

application/vnd.plcm.plcm-error+xml

Unable to get permission. Retrieving SNMP configuration requires administrator role.

409

application/vnd.plcm.plcm-error+xml

Data read from storage location is invalid.

500

application/vnd.plcm.plcm-error+xml

Server error. Failed to read from storage location.

 

 

PUT

Updates the SNMP configuration, such as SNMP version (v2c/v3), transport (UDP/TCP), port, authentication and encryption methods (MD5/SHA and DES/AES, respectively), etc. 

 

Request

Representations:

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

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

 

Response

Status

Representation

Description

204

 

SNMP configuration successfully updated.

400

 

Provided object does not adhere to schema definition.

401

 

Authentication required.

403

application/vnd.plcm.plcm-error+xml

Unable to get permission. Updating SNMP configuration requires administrator role.

409

application/vnd.plcm.plcm-error+xml

An error in the specified SNMP configuration. Further details supplied in response.

- Data updated in another session.

- A specified security user is not included in the security user list.

- A security user is defined twice in the security user list.

- An internet address in incorrect format.

- An invalid port specified.

- Listening port is already in use.

412

 

The object entity-tag is out-of-date; modified since last GET.

500

application/vnd.plcm.plcm-error+xml

Server Error.

- Snmpd service failed to either stop or start.

- Data storage error.

- Failed in verifying current port usage.