The SNMP configuration for listening agent and trap sending to notification agents.
urn:com:polycom:api:rest:plcm-snmp-config-notification-agent-v2
urn:com:polycom:api:rest:plcm-snmp-config-trap-sinks-v2
urn:com:polycom:api:rest:plcm-snmp-config-pass-list-v2
http://www.w3.org/2005/Atom
Root Element: plcm-snmp-config
Name |
Type |
Description |
|---|---|---|
enabled |
xs:boolean |
Is SNMP Agent turned on? Mandatory |
product |
xs:string of length <=1 >=64 |
Product name controlling this agent. Set to "RPCS". Mandatory |
transport |
plcm-snmp-config:plcm-snmp-config-transport |
Transport type. Mandatory |
version |
plcm-snmp-config:plcm-snmp-config-version |
SNMP version. Mandatory |
port |
xs:int |
SNMP listening port. Default value: 161. 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 >=64 |
The security user login name for this SNMP agent. Note: Must be in the plcm-snmp-config-security-user list. Applicable for SNMP version 3 only. Mandatory |
minimum-notification-interval |
xs:int |
Ignored. Mandatory |
notification-agent |
list of plcm-snmp-config:plcm-snmp-config-notification-agent |
The list of agents to which snmpd sends traps. |
list of plcm-snmp-config:plcm-snmp-config-security-user |
The list of security users used for external notification agents. Applicable for SNMP version 3 only. |
|
plcm-snmp-config-pass-list |
list of plcm-snmp-config-v2:plcm-snmp-config-pass-list-v2 |
Ignored. |
plcm-snmp-config-trap-sinks |
list of plcm-snmp-config-v2:plcm-snmp-config-trap-sinks-v2 |
Ignored. |
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 |
PlcmSnmpConfigNotificationAgent
Name |
Type |
Description |
|---|---|---|
enabled |
xs:boolean |
Is SNMP Agent turned on? Mandatory |
plcm-snmp-config-transport |
plcm-snmp-config:plcm-snmp-config-transport |
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 |
Port of the external notification agent.. Note: For trap notifications, 162 is the only accepted value. Other values result in transaction rejection. Mandatory |
plcm-snmp-config-notification-type |
plcm-snmp-config:snmp-config-notification-type |
The SNMP notification type. Mandatory |
version |
plcm-snmp-config:plcm-snmp-config-version |
SNMP version. Mandatory |
security-user-login |
xs:string of length <=1 and >=64 |
Security-user login for this SNMP agent. Note: Must be in the plcm-snmp-config-security-user list. 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. Mandatory |
Name |
Type |
Description |
|---|---|---|
login |
xs:string of length <=1 and >=64 |
Security user login name. Mandatory |
authentication-password |
xs:string of length >=1 and <=64 |
The authentication password. Mandatory |
encryption-password |
xs:string of length >=1 and <=64 |
The encryption password. Mandatory |
plcm-snmp-config-authentication-type |
plcm-snmp-config:plcm-snmp-config-authentication-type |
The authentication protocol. Mandatory |
plcm-snmp-config-encryption-type |
plcm-snmp-config:plcm-snmp-config-encryption-type |
The privacy protocol Mandatory |
Name |
Type |
Restrictions |
|---|---|---|
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: - "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: - "MD5" - "SHA" |
|
Enumeration Each value of type xs:string |
Value is one of: - "TRAP" - "INFORM" |
|
Enumeration Each value of type xs:string |
Value is one of: - "DES" - "AES" |
|
xs:string |
Length of value must be >=1 and <=64. |