PlcmDeviceV3

PlcmDeviceV3

This object defines a voice or video device which can either register with the Polycom Call Server through H.323 and/or SIP or be manually added. Currently this includes both hard and soft endpoint and MCUs. While the intent of this module is for devices which register themselves with the Call Server, it also allows for endpoint and MCUs which are manually added to the Call Server, but not registered through H.323 or SIP. All attributes are used in ETag calculation except for entity-tag and atom-link.


PlcmDeviceV3 Fields

NameTypeDescriptionAttributes
deviceAdmissionPolicyPlcmDeviceAdmissionPolicyEnum
callForwardingRuleListPlcmCallForwardingRuleList
plcmDeviceStatus PlcmDeviceStatusSee Definition of PlcmDeviceStatus
atomLinkList Array of LinkSee Definition of Link
plcmMcuIdentity PlcmMcuIdentitySee Definition of PlcmMcuIdentity
plcmSipIdentityV2 PlcmSipIdentityV2See Definition of PlcmSipIdentityV2
plcmIsdnIdentity PlcmIsdnIdentitySee Definition of PlcmIsdnIdentity
plcmH323Identity PlcmH323IdentitySee Definition of PlcmH323Identity
plcmServiceClassV2 PlcmServiceClassV2See Definition of PlcmServiceClassV2
deviceIdentifierDeviceIdentifier The Call Server device identifier. This is read-only for clients.
deviceNamestring Indicates device name.
deviceOwnerstring The user account associated with the device, i.e the device owner.
ownerDomainstring The domain of the user account.
deviceModelstring Model of the device.
deviceVersionstring Device software version.
registrationIdentifierstring Unique identifier of the devices registration with the call server.
allowInactivityDeletionboolean Allow the device to be automatically deleted if its registration is inactive for a prolonged period of time. The amount of time a device must be inactive for is based on the settings of the Call Server's registration policy. This will be set to true by default when a new device is created.
registrationDirectionRegistrationDirection Direction of the device registration. This value is read-only for clients.
supportsH323boolean Flag indicating if the device supports H.323.
supportsIsdnboolean Flag indicating if the device supports ISDN.
supportsSipboolean Flag indicating if the device supports SIP
hasMcuCapabilitiesboolean Flag indicating if the device has MCU capabilities.
ipAddressstring Device IP address.
areaIdentifierstring Indicates to which area device belongs to.
schedulerDeviceboolean Indicates if device can be scheduled or not.
passbackPassback User defined value for that is opaque to the system
passthruPassthru User defined value that that is opaque to the system. Note: that this parameter can be used to pass through to other, internal, persistent areas of the system such as Call Data Records.
entityTagEntityTag 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.
deviceTypestring Device type, only available from Resource Manager
manageModestring Manage mode: VC2 mode or blank, only available from Resource Manager
serialNumberstring Serial Number, only available from Resource Manager.
sitestring Site name.
isIndirectboolean A value of true indicates the device is behind an edge device like a VBP, SBC, RPAD, etc. This is read-only for clients.
deviceAuthenticationboolean Device authentication value. Mandatory
neverDeleteDueToInactivityboolean Prevents the registration from ever expiring. Only considered while updating any device.
alertOnRegistrationLossboolean If the device unregisters from the Call Server or its registration expires, an informational alert is triggered. Only considered while updating any device.
complianceLevelComplianceLevel Indicates whether the device is compliant or noncompliant with the applicable registration policy script
territorystring Territory name.
registrationPolicyExceptionstring Shows any exceptions with which the device was flagged as a result of applying a registration policy.
activeCallsint Indicates number of calls of a device.
ownerUserUuidstring The uuid of the user account.
ownerRoomUuidstring The uuid of the room account.
pathHeaderArray of string Path header
sipUsernamestring Sip Username
authenticationNamestring Authentication Name


Nested Types/Restrictions


NameTypeRestrictions
ComplianceLevelstring
Value must be one of:
  • COMPLIANT
  • NONCOMPLIANT
  • NEXT_LEVEL
  • UNKNOWN
EntityTagstring
Length of value must be >=1
Length of value must be <=64
Passthrustring
Length of value must be >=1
Length of value must be <=512
Passbackstring
Length of value must be >=1
Length of value must be <=512
RegistrationDirectionstring
Value must be one of:
  • INCOMING
  • OUTGOING
DeviceIdentifierstring
Length of value must be >=1
Length of value must be <=36