plcm-snmp-config.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-snmp-config-version  PlcmSnmpConfigVersion

Specifies snmp version.

plcm-snmp-config-transport  PlcmSnmpConfigTransport

Specifies snmp transport type.

plcm-snmp-config-authentication-type  PlcmSnmpConfigAuthenticationType

Specifies snmp authentication type.

plcm-snmp-config-notification-type  PlcmSnmpConfigNotificationType

Specifies snmp notification type.

plcm-snmp-config-encryption-type  PlcmSnmpConfigEncryptionType

Specifies snmp encryption type.

plcm-snmp-config-minimum-notification-interval  PlcmSnmpConfigMinimumNotificationInterval

Specifies snmp minimum-notification-interval.

plcm-snmp-config-trap-sinks  PlcmSnmpConfigTrapSinks

Configurations for the trapsink line on snmpd.

plcm-snmp-config-pass-list  PlcmSnmpConfigPassList

Configurations for the pass line on snmpd.

plcm-snmp-config-security-user  PlcmSnmpConfigSecurityUser

Security user used for external notification agents.

plcm-snmp-config-notification-agent  PlcmSnmpConfigNotificationAgent

Agent where snmpd will send traps.

plcm-snmp-config  PlcmSnmpConfig

Snmp configuration for listening agent and sending traps to notification agents


Complex Types

PlcmSnmpConfig Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
plcmSnmpConfigTrapSinksList List of plcm-snmp-config-trap-sinksSee Definition of plcm-snmp-config-trap-sinks
plcmSnmpConfigPassListList List of plcm-snmp-config-pass-listSee Definition of plcm-snmp-config-pass-list
plcmSnmpConfigSecurityUserList List of plcm-snmp-config-security-userSee Definition of plcm-snmp-config-security-user
plcmSnmpConfigNotificationAgentList List of plcm-snmp-config-notification-agentSee Definition of plcm-snmp-config-notification-agent
plcm-snmp-config-minimum-notification-interval plcm-snmp-config-minimum-notification-intervalSee Definition of plcm-snmp-config-minimum-notification-intervalMandatory
plcm-snmp-config-version plcm-snmp-config-versionSee Definition of plcm-snmp-config-versionMandatory
plcm-snmp-config-transport plcm-snmp-config-transportSee Definition of plcm-snmp-config-transportMandatory
enabledxs:boolean Is Snmp Agent turned on? Mandatory
productProduct Product name controlling this snmp agent Mandatory
portxs:int Snmp port for listening Mandatory
communityCommunity Community name controlling this snmp agent Mandatory
contactContact Contact name controlling this snmp agent Mandatory
locationLocation Location name for this snmp agent. Applied to RPRM, location can be POLYCOM_RESOURCE_SCHEDULE_MANAGEMENT or POLYCOM_CMA_MIB. Mandatory
security-userSecurityUser Security-user login for this snmp agent. This user must exist in the security user list contained in this API
entity-tagEntityTag 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.

PlcmSnmpConfigNotificationAgent Fields

NameTypeDescriptionAttributes
plcm-snmp-config-version plcm-snmp-config-versionSee Definition of plcm-snmp-config-versionMandatory
plcm-snmp-config-notification-type plcm-snmp-config-notification-typeSee Definition of plcm-snmp-config-notification-typeMandatory
plcm-snmp-config-transport plcm-snmp-config-transportSee Definition of plcm-snmp-config-transportMandatory
enabledxs:boolean Is Snmp Agent turned on? Mandatory
addressAddress FQDN or IP address of external notification agent Mandatory
portxs:unsignedInt Port of external notification agent Mandatory
security-user-loginSecurityUserLogin Security user to use for this agent. This user must be defined in the security users list of the enclosing snmp-config object
client-dataClientData Client data that is stored and retreived with this this agent, but not written to snmpd.conf. For rprm, it is reserved, it is same as leaf enabled, but will not be saved, and if changed internal, it will return same value as leaf enabled. Mandatory

PlcmSnmpConfigSecurityUser Fields

NameTypeDescriptionAttributes
plcm-snmp-config-encryption-type plcm-snmp-config-encryption-typeSee Definition of plcm-snmp-config-encryption-typeMandatory
plcm-snmp-config-authentication-type plcm-snmp-config-authentication-typeSee Definition of plcm-snmp-config-authentication-typeMandatory
loginLogin Security user name
user-authentication-passwordUserAuthenticationPassword Authentication-password
user-encryption-passwordUserEncryptionPassword Encryption-password

PlcmSnmpConfigPassList Fields

NameTypeDescriptionAttributes
oid-to-passOidToPass base oid to pass to a program Mandatory
program-pathProgramPath Path of the program to receive the passed data Mandatory

PlcmSnmpConfigTrapSinks Fields

NameTypeDescriptionAttributes
hostHost FQDN or IP of host to trap sink to Mandatory
trap-communityTrapCommunity SNMP Community to trap sink to Mandatory
portxs:unsignedInt Port to trap sink to Mandatory


Simple Types


NameTypeRestrictions
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
SecurityUserxs:string
Length of value must be >=1
Length of value must be <=64
Locationxs:string
Length of value must be >=1
Length of value must be <=64
Contactxs:string
Length of value must be >=1
Length of value must be <=64
Communityxs:string
Length of value must be >=1
Length of value must be <=256
Productxs:string
Length of value must be >=1
Length of value must be <=64
ClientDataxs:string
Length of value must be >=1
Length of value must be <=64
SecurityUserLoginxs:string
Length of value must be >=1
Length of value must be <=64
Addressxs:string
Length of value must be >=1
Length of value must be <=64
UserEncryptionPasswordxs:string
Length of value must be >=1
Length of value must be <=64
UserAuthenticationPasswordxs:string
Length of value must be >=1
Length of value must be <=64
Loginxs:string
Length of value must be >=1
Length of value must be <=64
ProgramPathxs:string
Length of value must be >=1
Length of value must be <=256
OidToPassxs:string
Length of value must be >=1
Length of value must be <=64
TrapCommunityxs:string
Length of value must be >=1
Length of value must be <=64
Hostxs:string
Length of value must be >=1
Length of value must be <=64
PlcmSnmpConfigMinimumNotificationIntervalxs:string
Value must be one of:
  • NONE
  • FIVE_MINUTES
  • FIFTEEN_MINUTES
  • ONE_HOUR
  • SIX_HOURS
  • ONE_DAY
PlcmSnmpConfigEncryptionTypexs:string
Value must be one of:
  • DES
  • AES
PlcmSnmpConfigNotificationTypexs:string
Value must be one of:
  • TRAP
  • INFORM
PlcmSnmpConfigAuthenticationTypexs:string
Value must be one of:
  • MD5
  • SHA
PlcmSnmpConfigTransportxs:string
Value must be one of:
  • UDP
  • TCP
PlcmSnmpConfigVersionxs:string
Value must be one of:
  • SNMP_V2C
  • SNMP_V3