Share via

2.2.2.5.1 Data Model for ServerConfiguration provisionGroup

  • Article

Unless specified otherwise, all the properties are required and have a cardinality of 1.<36>

 provisionGroup (name='ServerConfiguration')
 |
 |-- absWebServiceEnabled
 |-- lisInternalUrl
 |-- absInternalServerUrl
 |-- absExternalServerUrl
 |-- abwqInternalUrl
 |-- abwqExternalUrl
 |-- dlxInternalUrl
 |-- dlxExternalUrl
 |-- dlxEnabled
 |-- updatesServerInternalUrl
 |-- updatesServerExternalUrl
 |-- updatesServerEnabled
 |-- organization
 |-- helpdeskInternalUrl
 |-- helpdeskExternalUrl
 |-- consoleDownloadInternalUrl
 |-- consoleDownloadExternalUrl
 |-- ucPortRangeEnabled
 |-- ucMinMediaPort
 |-- ucMaxMediaPort
 |-- ucMinSipDynamicPort
 |-- ucMaxSipDynamicPort
 |-- ucMinAudioPort
 |-- ucMaxAudioPort
 |-- ucMinVideoPort
 |-- ucMaxVideoPort
 |-- ucMinAppSharingPort
 |-- ucMaxAppSharingPort
 |-- ucMinFileTransferPort
 |-- ucMaxFileTransferPort
 |-- ucPC2PCAVEncryption
 |-- ucMaxVideoRateAllowed
 |-- qosEnabled
 |-- enableInCallQoS
 |-- inCallQoSIntervalSeconds
 |-- ucDiffServVoice
 |-- ucVoice802_1p
 |-- ucEnforcePinLock
 |-- ucMinPinLength
 |-- ucPhoneTimeOut
 |-- ucExchangeMWIPoll
 |-- ucEnableSIPSecurityMode
 |-- ucEnableUserLogging
 |-- loggingLevel
 |-- enableBWPolicyCheck
 |-- poolUri
 |-- mrasUri
 |-- qosUri
 |-- callParkServerUri
 |-- responseGroupServiceInternalURL
 |-- responseGroupServiceExternalURL
 |-- responseGroupServiceInternalAgentURL
 |-- responseGroupServiceExternalAgentURL
 |-- botSipUriForTestCall
 |-- cwaInternalUri
 |-- cwaExternalUri
 |-- ucLocationProfile
 |-- focusFactoryUri
 |-- voiceMailUri

This provision group example follows the behavior described in endnote <37>.

provisionGroup (name='ServerConfiguration')
     |
     |-- ucMaxVideoRateAllowed
     |-- absInternalServerUrl
     |-- absExternalServerUrl
     |-- absWebServiceEnabled
     |-- ucPC2PCAVEncryption
     |-- organization
     |-- consoleDownloadInternalUrl
     |-- consoleDownloadExternalUrl
     |-- helpdeskInternalUrl
     |-- helpdeskExternalUrl
     |-- dlxInternalUrl
     |-- dlxExternalUrl
     |-- dlxEnabled
     |-- ucDiffServVoice
     |-- ucVoice802_1p
     |-- ucEnforcePinLock
     |-- ucMinPinLength
     |-- ucPhoneTimeOut
     |-- ucExchangeMWIPoll
     |-- ucEnableSIPSecurityMode
     |-- ucEnableUserLogging
     |-- updatesServerInternalUrl
     |-- updatesServerExternalUrl
     |-- updatesServerEnabled
     |-- ucPortRangeEnabled
     |-- ucMinMediaPort
     |-- ucMaxMediaPort
     |-- ucMinSipDynamicPort
     |-- ucMaxSipDynamicPort
     |-- qosEnabled
     |-- enableInCallQoS
     |-- inCallQoSIntervalSeconds
     |-- ucLocationProfile
     |-- mrasUri
     |-- qosUri
     |-- callControlServerUri
     |-- poolUri
     |-- cwaInternalUri
     |-- cwaExternalUri
     |-- focusFactoryUri
     |-- voiceMailUri

The following XSD schema fragment defines the requirements to which a ServerConfiguration provisionGroup element XML document MUST conform.

  
 <?xml version="1.0" encoding="utf-16"?>
 <xs:schema xmlns:tns="http://schemas.microsoft.com/2006/09/sip/provisiongrouplist-notification" targetNamespace="http://schemas.microsoft.com/2006/09/sip/provisiongrouplist-notification" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:element name="provisionGroup" type="tns:provisionGroupType" />
   <xs:complexType name="provisionGroupType">
     <xs:all minOccurs="0" maxOccurs="1">
 <xs:element minOccurs="0" maxOccurs="1" name="absWebServiceEnabled" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="lisInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="absInternalServerUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="absExternalServerUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="abwqInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="abwqExternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="dlxInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="dlxExternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="dlxEnabled" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="updatesServerInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="updatesServerExternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="updatesServerEnabled" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucPortRangeEnabled" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="organization" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="helpdeskInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="helpdeskExternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="consoleDownloadInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="consoleDownloadExternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinMediaPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxMediaPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinSipDynamicPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxSipDynamicPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinAudioPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxAudioPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinVideoPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxVideoPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinAppSharingPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxAppSharingPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinFileTransferPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxFileTransferPort" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucPC2PCAVEncryption" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMaxVideoRateAllowed" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="qosEnabled" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="EnableInCallQoS" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="InCallQoSIntervalSeconds" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucDiffServVoice" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucVoice802_1p" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucEnforcePinLock" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucMinPinLength" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucPhoneTimeOut" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucExchangeMWIPoll" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucEnableSIPSecurityMode" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucEnableUserLogging" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="loggingLevel" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="enableBWPolicyCheck" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="poolUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="mrasUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="qosUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="callControlServerUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="callParkServerUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="responseGroupServiceInternalURL" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="responseGroupServiceExternalURL" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="responseGroupServiceInternalAgentURL" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="responseGroupServiceExternalAgentURL" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="botSipUriForTestCall" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="cwaInternalUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="cwaExternalUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="requireFIPSCompliantMedia" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="hybridConfigServiceInternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="hybridConfigServiceExternalUrl" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="ucLocationProfile" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="focusFactoryUri" type="tns:propertyType" />
 <xs:element minOccurs="0" maxOccurs="1" name="voiceMailUri" type="tns:propertyType" />
  
     </xs:all>
     <xs:attribute fixed="ServerConfiguration" name="name" use="required" />
   </xs:complexType>
 </xs:schema>

ucMaxVideoRateAllowed: Maximum video rate that the UAC endpoints are to use. The maximum video rate MUST be one of the following defined values:

  • default: Maximum resolution of VGA-600K.

  • HD720P-1.5M: Maximum resolution of HD720P. High definition, with a resolution of 1280x720.

  • VGA-600K: Maximum resolution of VGA, 640x480, 25 fps.

  • CIF-250K<38>: Maximum resolution of Common Intermediate Format (CIF). CIF has a resolution of 352x288, 15 fps.

    absInternalServerUrl: The URI where the Address Book Service can be reached within the enterprise. This SHOULD be a Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS) URI pointing to the virtual directory in which the Address Book Service places the address book files, as specified in [MS-ABS] section 2.2.

    absExternalServerUrl: The URI where the Address Book Service can be reached through the public internet. This SHOULD be an HTTPS URI pointing to the virtual directory where the Address Book Service places the Address Book files, as specified in [MS-ABS] section 2.2.

    ucPC2PCAVEncryption: Specifies whether encryption is required for Computer to Computer Audio-Video Sessions. ucPC2PCAVEncryption MUST be one of the following defined values:

  • SupportEncryption: Encryption is optional.

  • RequireEncryption: Encryption is required.

  • DoNotSupportEncryption: Encryption is not required.

    organization: The name of the organization.

    consoleDownloadInternalUrl<39>: The URI from which the meeting console can be downloaded within the enterprise. This SHOULD be an HTTP URI. For example:

     "http://r.office.fabrikam.com/r/rlidOCS?clid=1033&amp;p1=livemeeting"

    consoleDownloadExternalUrl<40>: The URI from which the meeting console can be downloaded through the public internet. This SHOULD be an HTTP URI. For example:

     "http://r.office.fabrikam.com/r/rlidOCS?clid=1033&amp;p1=livemeeting"

    helpdeskInternalUrl<41>: The URI for the organization’s help desk within the enterprise. This SHOULD be an HTTP URI.

    helpdeskExternalUrl<42>: The URI for the organization’s help desk through the public internet. This SHOULD be an HTTP URI.

    dlxInternalUrl: The URI for the Group Expansion Web Service component within the enterprise. This SHOULD be an HTTPS URI pointing to the Group Expansion Web Service, as specified in [MS-DLX] section 2.

    dlxExternalUrl: The URI for the Group Expansion Web Service component through the public internet. This SHOULD be an HTTPS URI pointing to the Group Expansion Web Service, as specified in [MS-DLX] section 2.

    dlxEnabled: Indicates whether the Group Expansion Web Service is available. The value MUST be "true" or "false".

    ucDiffServVoice: Ignored.

    ucVoice802_1p: Ignored.

    ucEnforcePinLock: Ignored.

    ucMinPinLength: Ignored.

    ucPhoneTimeOut: Ignored.

    ucEnableUserLogging:<43> Indicates whether logging needs to be enabled on the user computer to record client behavior. The value SHOULD be "true" or "false".

    ucExchangeMWIPoll: Ignored.

    ucEnableSIPSecurityMode: The security mode for the client. The value MUST be "High", "Medium", or "Low".

    updatesServerInternalUrl: Ignored.

    updatesServerExternalUrl: Ignored.

    updatesServerEnabled: Ignored.

    ucPortRangeEnabled:<44> Indicates whether the port ranges sent by the server need to be used by the client for media and signaling. The value SHOULD be "true" or "false".

    ucMinMediaPort:<45> The minimum of the range of dynamically-allocated ports that the client can use to transmit audio and video data using Real-Time Transport Protocol (RTP).

    ucMaxMediaPort:<46> The maximum of the range of dynamically-allocated ports that the client can use to transmit audio and video data using RTP.

    ucMinSipDynamicPort:<47> The minimum of the range of dynamically-allocated ports that the client can use to transmit signaling data using SIP.

    ucMaxSipDynamicPort:<48> The maximum of the range of dynamically-allocated ports that the client can use to transmit signaling data using SIP.

    qosEnabled:<49> Optional. Ignored.

    ucLocationProfile: The location profile for voice call features. This is used by the extensions described in [MS-SIPRE] section 2.2.8.

    mrasUri: The URI of the Media Relay Authentication Service (MRAS), as specified in [MS-AVEDGEA] section 2.2.3.1.2. This MUST be a SIP URI that can be used to address the MRAS Service.

    qosUri: The URI of the Media QoE Monitoring Server, as described in [MS-QoE] section 1.3. This MUST be a SIP URI that can be used to address the QoE Service.

    callControlServerUri:<50> Ignored.

    poolUri:<51> Ignored.

    cwaInternalUri:<52> The URI for the organization’s phone conferencing dial-in information page, accessible internally. This SHOULD be an HTTP(S) URI.

    cwaExternalUri:<53> The URI for the organization’s phone conferencing dial-in information page, accessible externally. This SHOULD be an HTTP(S) URI.

    focusFactoryUri: The User’s Conferencing Focus Factory. This is required for creating conferences. This MUST be a SIP URI.

    voiceMailUri: The user’s voice mail URI. This is required for sending messages to voice mail. This MUST be a SIP URI that can be used to route to the user’s voice mail. The syntax is described in [MS-SIPRE] section 2.2.3.

    responseGroupServiceInternalURL:<54> The Uniform Resource Locator (URL) for the Response Group Service Web Service within the enterprise. This MUST be an HTTPS URL pointing to the Response Group Service Web Service, as specified in [MS-RGSWS].

    responseGroupServiceExternalURL:<55> The URL for the Response Group Service Web Service through the public internet. This MUST be an HTTPS URL pointing to the Response Group Service Web Service, as specified in [MS-RGSWS].

    responseGroupServiceInternalAgentURL:<56> The URL of a webpage containing information about the Response Group Service within the enterprise. This SHOULD be an HTTPS URL.

    responseGroupServiceExternalAgentURL:<57> The URL of a webpage containing information about the Response Group Service through the public internet. This SHOULD be an HTTPS URL.

    absWebServiceEnabled: Ignored.

    abwqExternalURL:<58> The Address Book Web Query URL. This is accessible through the public internet. This SHOULD be an HTTPS URI pointing to the Group Expansion Web Service, as specified in [MS-DLX] section 2.

    abwqInternalURL:<59> The Address Book Web Query URL. This is accessible inside the enterprise/intranet. This SHOULD be an HTTPS URI pointing to the Group Expansion Web Service, as specified in [MS-DLX] section 2.

    botSipUriForTestCall:<60> The SIP URI of the test bot that is available to the user for a test call.

    callParkServerUri:<61> The URI for the call park server that clients can connect to.

    enableBWPolicyCheck:<62> Boolean value that indicates whether the system is provisioned for bandwidth management.

    lisInternalUrl:<63> The URL of the Location Information Service, as specified in [MS-E911WS] section 3.1, which is accessible from inside the enterprise/intranet.

    loggingLevel:<64> The logging level on the client.

    ucMinAppSharingPort:<65> Minimum port used by Application Sharing.

    ucMaxAppSharingPort:<66> Maximum port used by Application Sharing.

    ucMinAudioPort:<67> Minimum port used by Audio.

    ucMaxAudioPort:<68> Maximum port used by Audio.

    ucMinFileTransferPort:<69> Minimum port used for File Transfer.

    ucMaxFileTransferPort:<70> Maximum port used for File Transfer. This is for P2P File Transfers only.

    ucMinVideoPort:<71> Minimum port used by Video.

    ucMaxVideoPort:<72> Maximum port used by Video.

    requireFIPSCompliantMedia:<73> Boolean value that requires the client to be FIPS compliant in all audio video conversations if present, and has the value of "true".

    hybridConfigServiceInternalUrl:<74> The internal URL of a web service used to enable media bypass, E911, call park, and call center services for hybrid voice users.

    hybridConfigServiceExternalUrl:<75> The external URL of a web service used to enable media bypass, E911, call park, and call center services for hybrid voice users.

    enableInCallQos: <76> Whether the client will send in-call QoS metrics (value is set to "true"), or not ("false").

    inCallQoSIntervalSeconds: <77> The number of seconds in the minimum time interval between sending one in-call QoS metric and sending the next.

For a detailed example, see section 4.2.2.