The SNMP configuration API (API version 2) for listening agent and trap sending to notification agents.
Additional documented schemas include:
urn:com:polycom:api:rest:plcm-snmp-config-transport-v2
urn:com:polycom:api:rest:plcm-snmp-config-version-v2
urn:com:polycom:api:rest:plcm-snmp-config-minimum-notification-interval-v2
urn:com:polycom:api:rest:plcm-snmp-config-notification-agent-v2
urn:com:polycom:api:rest:plcm-snmp-security-user-agent-v2
urn:com:polycom:api:rest:plcm-snmp-engine-id-agent-v2
urn:com:polycom:api:rest:plcm-snmp-config-pass-list-v2
urn:com:polycom:api:rest:plcm-snmp-config-trap-sinks-v2
http://www.w3.org/2005/Atom
Root Elements:
Name |
Type |
Description |
|---|---|---|
enabled |
xs:boolean |
Is SNMP Agent turned on? Mandatory |
product |
xs:string of length <=1 and >=64 |
Product name controlling this SNMP agent. Mandatory |
transport |
plcm-snmp-config-transport-v2:plcm-snmp-config-transport-v2 |
Transport type. Mandatory |
version |
plcm-snmp-config-version-v2:plcm-snmp-config-version-v2 |
SNMP version. Mandatory |
port |
xs:int |
SNMP listening port for listening. Mandatory |
community |
xs:string of length <=1 >=64 |
Community name controlling this SNMP agent. Default value: "Public" Mandatory |
contact |
xs:string of length <=1 >=64 |
Contact name controlling this SNMP agent. Default value: "Administrator" Mandatory |
location |
xs:string of length <=1 >=64 |
Location of this SNMP agent. Default value: "Earth" Mandatory |
security-user |
xs:string of length <=1 >=31 |
The security user login name for this SNMP agent. Note: Must be defined in the security users list of the enclosing snmp-config object. Mandatory |
plcm-snmp-config-minimum-notification-interval-v2:plcm-snmp-config-minimum-notification-interval-v2 (xs:int) |
Ignored. Mandatory |
|
plcm-snmp-config-notification-agent-v2 |
list of plcm-snmp-config-notification-agent-v2:plcm-snmp-config-notification-agent-v2 |
An agent to which snmpd sends traps. |
plcm-snmp-config-security-user-v2 |
list of plcm-snmp-config-security-user-v2:plcm-snmp-config-security-user-v2 |
The security user used for external notification agents. Note: The API does not support "no privacy, not authorized" in the User-based Security Model. |
plcm-snmp-config-pass-list-v2 |
list of plcm-snmp-config-pass-list-v2:plcm-snmp-config-pass-list-v2 |
Ignored. |
plcm-snmp-config-trap-sinks-v2 |
list of plcm-snmp-config-trap-sinks-v2:plcm-snmp-config-trap-sinks-v2 |
Ignored. |
plcm-snmp-config-engine-id-v2 |
list of plcm-snmp-config-engine-id-v2:plcm-snmp-config-engine-id-v2 |
The identity of the authorized SNMP entity. Applicable for SNMP v3 only! Note: Applicable only for GET (not UPDATE) |
entity-tag |
xs:string of length <=1 >=64 |
The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. |
atom-link |
See Definition of atom:link |
The atom links provided in the body of the resource |
PlcmSnmpConfigNotificationAgentV2
Name |
Type |
Description |
|---|---|---|
enabled |
xs:boolean |
Is SNMP Agent turned on? Mandatory |
plcm-snmp-config-notification-type |
plcm-snmp-config-notification-agent-v2:plcm-snmp-config-notification-type |
The SNMP notification type. Mandatory |
transport |
plcm-snmp-config-transport-v2:plcm-snmp-config-transport-v2 |
Transport type. Mandatory |
address |
xs:string of length <=1 and >=64 |
The FQDN or IP address of the external notification agent, which is the SNMP notification receiver. Mandatory |
port |
xs:int |
The SNMP listening port number. Note: For trap notifications, 162 is the only accepted value. Other values result in transaction rejection. Mandatory |
version |
plcm-snmp-config-version-v2:plcm-snmp-config-version-v2 |
SNMP version. Mandatory |
security-user-login |
xs:string of length <=0 >=31 |
The security user login name for this SNMP agent. Note: Must be defined in the security users list of the enclosing snmp-config object. Mandatory |
client-data |
xs:string of length <=1 and >=64 |
Client information stored and retrieved using this agent, but is not written to snmpd.conf. |
Name |
Type |
Description |
|---|---|---|
login |
xs:string of length <=1 >=31 |
Security user login name. Mandatory |
user-authentication-password |
xs:string of length <=8 and >=64 |
The authentication password. Note: This password is not returned when retrieving data. If not sent when updating/sending data, the previous password is used. |
user-encryption-password |
xs:string of length <=8 and >=64 |
The encryption password. Note: This password is not returned when retrieving data. If not sent when updating/sending data, the previous password is used. |
authentication-type |
Authentication type. Value is one of: - "MD5" - "SHA" Mandatory |
|
encryption-type |
Encryption type. Mandatory |
Name |
Type |
Description |
|---|---|---|
identifier |
Length of value >=0 and <=64 |
Identifies what this engine ID belongs to. Can be one of: -FQDN -FQDN-browsing/FQDN-traps. Read only. Any sent values are ignored. |
engine-id |
Length of value >=0 and <=64 |
The engine ID. Read only. Any sent values are ignored. |
Name |
Type |
Restrictions |
|---|---|---|
Enumeration Each value of type xs:string |
Value is one of: - "UDP" - "TCP" Note: For trap notifications, "UDP" is the only accepted value. Other values result in transaction rejection. |
|
Enumeration Each value of type xs:string |
Value is one of: - "TRAP" - "INFORM" |
|
Enumeration Each value of type xs:string |
Value is one of: - "SNMP_V2C" - "SNMP_V3" Note: In User-based Security Model (USM), "SNMP_V3" is the only accepted value. |
|
Enumeration Each value of type xs:string |
Value is one of: - "MD5" - "SHA" |
|
Enumeration Each value of type xs:string |
Value is one of: - "DES" - "AES" |
|
xs:string |
Length of value >=1 and <=64 |