plcm-device-v4.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-device-v4  PlcmDeviceV4

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.


Complex Types

PlcmDeviceV4 Fields

NameTypeDescriptionAttributes
plcm-poly-evo-identity plcm-poly-evo-identitySee Definition of plcm-poly-evo-identity
device-admission-policyPlcmDeviceAdmissionPolicyEnum
call-forwarding-rule-listPlcmCallForwardingRuleList
plcm-device-status plcm-device-statusSee Definition of plcm-device-status
atomLinkList List of linkSee Definition of link
plcm-mcu-identity plcm-mcu-identitySee Definition of plcm-mcu-identity
plcm-sip-identity-v2 plcm-sip-identity-v2See Definition of plcm-sip-identity-v2
plcm-isdn-identity plcm-isdn-identitySee Definition of plcm-isdn-identity
plcm-h323-identity-v2 plcm-h323-identity-v2See Definition of plcm-h323-identity-v2
plcm-service-class-v2 plcm-service-class-v2See Definition of plcm-service-class-v2
device-identifierDeviceIdentifier The Call Server device identifier. This is read-only for clients.
device-namexs:string Indicates device name.
device-ownerxs:string The user account associated with the device, i.e the device owner.
owner-domainxs:string The domain of the user account.
device-modelxs:string Model of the device.
device-versionxs:string Device software version.
registration-identifierxs:string Unique identifier of the devices registration with the call server.
allow-inactivity-deletionxs:boolean 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.
registration-directionRegistrationDirection Direction of the device registration. This value is read-only for clients.
override-default-service-classxs:boolean When true, plcm-service-class-v2 must be specified in the request. When false, plcm-service-class-v2 value will be determined by the system default.
supports-h323xs:boolean Flag indicating if the device supports H.323.
supports-isdnxs:boolean Flag indicating if the device supports ISDN.
supports-sipxs:boolean Flag indicating if the device supports SIP
supports-poly-evoxs:boolean Flag indicating if the device supports Poly EVO.
has-mcu-capabilitiesxs:boolean Flag indicating if the device has MCU capabilities.
ip-addressxs:string Device IP address.
area-identifierxs:string Indicates to which area device belongs to.
scheduler-devicexs:boolean 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.
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.
device-typexs:string Device type, only available from Resource Manager
manage-modexs:string Manage mode: VC2 mode or blank, only available from Resource Manager
serial-numberxs:string Serial Number, only available from Resource Manager.
sitexs:string Site name.
is-indirectxs:boolean A value of true indicates the device is behind an edge device like a VBP, SBC, RPAD, etc. This is read-only for clients.
device-authenticationxs:boolean Device authentication value. Mandatory
never-delete-due-to-inactivityxs:boolean Prevents the registration from ever expiring. Only considered while updating any device.
alert-on-registration-lossxs:boolean If the device unregisters from the Call Server or its registration expires, an informational alert is triggered. Only considered while updating any device.
compliance-levelComplianceLevel Indicates whether the device is compliant or noncompliant with the applicable registration policy script
territoryxs:string Territory name.
registration-policy-exceptionxs:string Shows any exceptions with which the device was flagged as a result of applying a registration policy.
active-callsxs:int Indicates number of calls of a device.
owner-user-uuidxs:string The uuid of the user account.
owner-room-uuidxs:string The uuid of the room account.
path-headerList of xs:string Path header
sip-usernamexs:string Sip Username
authentication-namexs:string Authentication Name
provisionedxs:boolean True if the device has been provisioned.
shared-registrationxs:boolean Flag for Shared Registration


Simple Types


NameTypeRestrictions
ComplianceLevelxs:string
Value must be one of:
  • COMPLIANT
  • NONCOMPLIANT
  • NEXT_LEVEL
  • UNKNOWN
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
Passthruxs:string
Length of value must be >=1
Length of value must be <=512
Passbackxs:string
Length of value must be >=1
Length of value must be <=512
RegistrationDirectionxs:string
Value must be one of:
  • INCOMING
  • OUTGOING
DeviceIdentifierxs:string
Length of value must be >=1
Length of value must be <=36