plcm-mcu-v6.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-mcu-v6  PlcmMcuV6

An MCU managed by the DMA system. Content-Type: application/vnd.plcm.plcm-mcu-v4+xml. All attributes are used in ETag calculation except for dma-audio-ports, dma-video-ports, dma-used-audio-ports, dma-used-video-ports, total-used-audio-ports, total-used-video-ports, entity-tag and atom-link-list.


Complex Types

PlcmMcuV6 Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
plcmMcuConnectionStatusList List of plcm-mcu-connection-statusSee Definition of plcm-mcu-connection-status
plcm-registration-admission-policy plcm-registration-admission-policySee Definition of plcm-registration-admission-policy
plcm-mcu-servicing-status plcm-mcu-servicing-statusSee Definition of plcm-mcu-servicing-status
plcm-mcu-capacity plcm-mcu-capacitySee Definition of plcm-mcu-capacity
plcm-dial-rule-preliminary plcm-dial-rule-preliminarySee Definition of plcm-dial-rule-preliminary
plcmGatewayProfileList List of plcm-gateway-profileSee Definition of plcm-gateway-profile
plcm-sip-transport-type plcm-sip-transport-typeSee Definition of plcm-sip-transport-type
plcm-service-class-v2 plcm-service-class-v2See Definition of plcm-service-class-v2
plcm-signaling-type-list plcm-signaling-type-listSee Definition of plcm-signaling-type-listMandatory
plcm-mcu-type plcm-mcu-typeSee Definition of plcm-mcu-typeMandatory
mcu-identifierxs:string Unique identifier of the MCU.
namexs:string Name of the MCU. Mandatory
management-ipxs:string Management IP of MCU; required if signaling addresses are not provided for the MCU.
management-usernamexs:string Administrative user ID with which the Polycom equipment can log into the MCU; required if signaling addresses are not provided for the MCU.
management-passwordxs:string Password for the administrative user ID; required if signaling addresses are not provided for the MCU.
permanentxs:boolean Indicates that the device's registration with the call server should never expire. For MCUs, this value should be true.
h323-signaling-ipList of xs:string The address used for H.323 signaling; required if login information is not specified for the MCU.
sip-signaling-ipxs:string The address used for SIP signaling; required if login information is not specified for the MCU.
is-gatewayxs:boolean Indicates that the device is available as an ISDN gateway device.
gateway-delimiterxs:string The dial string delimiter used to separate the session profile prefix from the ISDN E.164 number.
enabled-for-conference-roomsxs:boolean Indicates that the device is available as a conferencing resource for the Polycom DMA system's Conference Manager.
strip-prefixxs:boolean Indicates that the system should strip the prefix when a call that includes a prefix is routed to this MCU.
direct-dial-in-prefixxs:string The dialing prefix assigned to the MCU. Supplying this value makes the MCU available for direct prefix-based dialing.
media-addressesMediaAddresses Address used for media; required if login information is not specified for the MCU.
reserved-audio-portsxs:unsignedShort The number of audio ports on the MCU that is off-limits to DMA.
reserved-video-portsxs:unsignedShort The number of CIF video ports on the MCU that is off-limits to DMA.
reserved-cascading-portsxs:unsignedShort The number of CIF ports on the MCU reserved for cascading.
rmx-profilesRmxProfiles Profiles defined on this MCU (if the MCU supports the feature). Read-only.
ivr-servicesIvrServices IVR services defined on this MCU (if the MCU supports the feature). Read-only.
recording-linksRecordingLinks Recording links defined on this MCU (if the MCU supports the feature). Read-only.
overlapxs:boolean Indicates the MCU is in more than one pool.
dma-audio-portsxs:unsignedShort The number of audio ports on the MCU that is available to the DMA.
dma-video-portsxs:unsignedShort The number of CIF video ports on the MCU that is available to the DMA.
dma-used-audio-portsxs:unsignedShort The number of audio ports on the MCU that is currently used by DMA.
dma-used-video-portsxs:unsignedShort The number of CIF video ports on the MCU that is currently used by DMA.
total-used-audio-portsxs:unsignedShort Total number of audio ports on the MCU that is currently used.
total-used-video-portsxs:unsignedShort Total number of CIF video ports on the MCU that is currently used.
supports-SVCxs:boolean If the MCU supports SVC conference.
passbackPassback User defined value that is opaque to the system.
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.
alert-when-mcu-unregistersxs:boolean Indicates that the DMA should create a system alert when the MCU unregisters.
supports-lync2013-cascadingxs:boolean Indicates whether this MCU supports Lync2013 Cascading. Read-Only.
supports-webrtcxs:boolean Indicates whether this MCU supports WebRTC endpoints. Read-Only.
supports-lync2013-external-systems-cascadingxs:boolean Indicates whether this MCU supports Lync2013 external systems Cascading using Lync CAA. Read-Only.
reserved-cascading-ports-overallxs:unsignedShort The number of CIF ports on the MCU reserved for cascading across all conferences.
modelxs:string MCU model name. Read-Only.
versionxs:string MCU model version. Read-Only.
aliasesAliases List of alias associated with MCU. Read-Only.
sitexs:string Site associated with MCU. Read-Only.
territoryxs:string Territory associated with MCU. Read-Only.
owner-domainxs:string MCU owner's domain. Read-Only.
ownerxs:string MCU owner. Read-Only.
call-forwarding-rulesCallForwardingRules List of call forwarding rule. Read-Only.
aorxs:string Address of record for MCU. Read-Only.
sip-contact-addressesSipContactAddresses List of SIP contact headers. Read-Only.
sip-user-namexs:string User part of SIP URI. Read-Only.
path-headersPathHeaders List of SIP path headers. Read-Only.
registrar-addressxs:string Registrar address. Read-Only.
proxy-addressxs:string Proxy address. Read-Only.
ras-addressesRasAddresses List of RAS address. Read-Only.
authentication-namexs:string MCU authentication name. Read-Only.
device-authentication-enabledxs:boolean Authentication status. Read-Only.
compliance-levelComplianceLevel Registration compliance level. Read-Only.
registration-statusRegistrationStatus MCU registration status. Read-Only.
ip-addressesIpAddresses List of IP address associated with MCU. Read-only.
mcu-poolsMcuPools List of MCU pool name with which MCU is associated. Read-Only.
active-call-countxs:int Active call count on this MCU. Read-Only.
ivr-enabledxs:boolean IVR feature support status. Read-Only.
recording-enabledxs:boolean Recording feature support status. Read-Only.
supports-media-relayxs:boolean Media relay feature support status. Read-Only.
failure-rateFailureRate MCU call failure rate. Read-Only.
disconnects-last-24-hoursDisconnectsLast24Hours MCU logouts in past 24 hours. Read-Only.
supports-svc-cascadexs:boolean SVC cascade feature support status. Read-Only.
supports-ms-rdp-contentxs:boolean Indicates whether this MCU supports MS RDP content transcoding. Read-Only.
supports-in-conference-ivrxs:boolean Indicates whether this MCU supports externally defined in-conference IVR. Read-Only.
cif-to-hd-ratioCifToHdRatio Number of CIF ports divided by number of HD ports.

McuPools Fields

NameTypeDescriptionAttributes
mcu-poolList of xs:string MCU pool name with which MCU is associated.

IpAddresses Fields

NameTypeDescriptionAttributes
ip-addressList of xs:string IP address associated with MCU.

RasAddresses Fields

NameTypeDescriptionAttributes
ras-addressList of xs:string RAS address.

PathHeaders Fields

NameTypeDescriptionAttributes
path-headerList of xs:string SIP path header value.

SipContactAddresses Fields

NameTypeDescriptionAttributes
sip-contact-addressList of xs:string SIP contact header value.

CallForwardingRules Fields

NameTypeDescriptionAttributes
call-forwarding-ruleList of CallForwardingRule Call forwarding rule.

Aliases Fields

NameTypeDescriptionAttributes
aliasList of xs:string Alias associated with MCU.

RecordingLinks Fields

NameTypeDescriptionAttributes
recording-linkList of xs:string Name of a defined recording link.

IvrServices Fields

NameTypeDescriptionAttributes
ivr-serviceList of xs:string Name of a defined IVR service.

RmxProfiles Fields

NameTypeDescriptionAttributes
rmx-profileList of xs:string Name of a defined profile.

MediaAddresses Fields

NameTypeDescriptionAttributes
media-addressList of xs:string Address of a media path.


Simple Types


NameTypeRestrictions
CifToHdRatioxs:decimal
DisconnectsLast24Hoursxs:decimal
FailureRatexs:decimal
RegistrationStatusxs:string
Value must be one of:
  • NotRegistered
  • Inactive
  • Active
  • Blocked
  • Quarantined
  • QuarantinedInactive
ComplianceLevelxs:string
Value must be one of:
  • COMPLIANT
  • NONCOMPLIANT
  • NEXT_LEVEL
CallForwardingRulexs:string
Value must be one of:
  • FORWARD_UNCONDITIONALLY
  • FORWARD_ON_BUSY
  • FORWARD_NO_ANSWER
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
Passbackxs:string
Length of value must be >=1
Length of value must be <=512