Export (0) Print
Expand All
Expand Minimize

New-CsWebServiceConfiguration

 

Topic Last Modified: 2012-04-23

Creates a new collection of Web Services configuration settings.

New-CsWebServiceConfiguration -Identity <XdsIdentity> [-AllowAnonymousAccessToLWAConference <$true | $false>] [-CASigningKeyLength <UInt64>] [-Confirm [<SwitchParameter>]] [-DefaultValidityPeriodHours <UInt64>] [-EnableCertChainDownload <$true | $false>] [-EnableGroupExpansion <$true | $false>] [-Force <SwitchParameter>] [-InferCertChainFromSSL <$true | $false>] [-InMemory <SwitchParameter>] [-MACResolverUrl <String>] [-MaxCSRKeySize <UInt64>] [-MaxGroupSizeToExpand <UInt32>] [-MaxValidityPeriodHours <UInt64>] [-MinCSRKeySize <UInt64>] [-MinValidityPeriodHours <UInt64>] [-SecondaryLocationSourceUrl <String>] [-ShowDownloadCommunicatorAttendeeLink <$true | $false>] [-ShowJoinUsingLegacyClientLink <$true | $false>] [-TrustedCACerts <PSListModifier>] [-UseCertificateAuth <$true | $false>] [-UsePinAuth <$true | $false>] [-UseWindowsAuth <None | Negotiate | NTLM>] [-WhatIf [<SwitchParameter>]]

Many Microsoft Lync Server 2010 components are web-based: these components either use Web Services or webpages to carry out their tasks. For example, users employ a Web service when searching for new contacts in the Address Book or when using group expansion to view the individual members of a distribution group. Likewise, components ranging from dial-in conferencing to Microsoft Lync Server 2010 Control Panel use webpages as the interface between Lync Server 2010 and users.

The CsWebServiceConfiguration cmdlets enable administrators to manage Web Services configuration settings throughout the organization. This includes managing group expansion, certificate settings, and allowed authentication methods. Because you can configure different settings at the global, site, and service scope (albeit for only the Web Services service), you can customize Web Services capabilities for different users and different locations.

New Web Services configuration settings are created by using the New-CsWebServiceConfiguration cmdlet. Note that these settings can only be created at the site or service scope (and only for the Web Services service); your command will fail if you try to create a new collection at the global scope. Likewise, your command will fail if you try to create a new collection at, for instance, the Redmond site, and that site already hosts a collection of Web service settings.

Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsWebServiceConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsWebServiceConfiguration"}

 

Parameter Required Type Description

Identity

Required

Xds Identity

Unique identifier for the Web Services configuration settings to be created. To create settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To create settings configured at the service scope, use syntax similar to this: -Identity "service:WebServer:atl-cs-001.litwareinc.com". Note that any settings created at the service scope must be assigned to the Web Server service.

AllowAnonymousAccessToLWAConference

Optional

Boolean

When set to True (the default value), anonymous users will be allowed to attend Lync Web App (LWA) conferences.

CASigningKeyLength

Optional

Integer

Sets the size of the certification authority (CA) signing key, the private key used by a CA to sign digital certificates. The signing key length can be set to any integer value between 2048 and 16384 bytes; the default value is 2048.

DefaultValidityPeriodHours

Optional

Integer

When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. DefaultValidityPeriodHours represents the amount of time a certificate will remain valid if the client does not request a custom validity period.

DefaultValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). The default value is 4320 (180 days).

EnableCertChainDownload

Optional

Boolean

If set to True, servers presented with an authentication certificate will download the certificate chain for that certificate. The certificate chain traces an individual certificate back to the issuing CA. Certificates will not be accepted for authentication unless the certificate’s CA is trusted.

EnableGroupExpansion

Optional

If set to True, group expansion will be enabled in Microsoft Lync 2010. With group expansion, users can configure a distribution group as a contact, and then "expand" that group. When a group has been expanded, users can see all the individual members of a group and their current presence information.

InferCertChainFromSSL

Optional

Boolean

If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. Certificates will not be accepted for authentication unless the certificate’s CA is trusted.

MACResolverUrl

Optional

String

URL for a Web service capable of performing Media Access Control (MAC) resolution. MAC resolution involves taking an IP address and determining the MAC address of the network card associated with that IP address.

MaxCSRKeySize

Optional

Integer

Sets the maximum size of the certificate signing request (CSR) key. (A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size can be set to any integer value between 1024 and 16384 bytes. The default value is 16384.

MaxGroupSizeToExpand

Optional

Integer

Represents the maximum number of people that will be displayed when a group is expanded. For example, if MaxGroupSizeToExpand is set to 75, only the first 75 members of the group will be displayed any time the group is expanded.

MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. The default value is 100.

MaxValidityPeriodHours

Optional

Integer

When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. MaxValidityPeriodHours represents the maximum amount of time a client can request.

MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). The default value is 8760.

MinCSRKeySize

Optional

Integer

Sets the minimum size of the CSR key. The minimum size can be set to any integer value between 1024 and 16384 bytes. The default value is 16384.

MinValidityPeriodHours

Optional

Integer

When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. MinValidityPeriodHours represents the minimum amount of time a client can request.

MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). The default value is 8.

SecondaryLocationSourceUrl

Optional

String

URL for a Web service that can process a location request. This service is typically used only when location requests cannot be resolved locally.

ShowDownloadCommunicatorAttendeeLink

Optional

String

If set to True (the default value), users joining a meeting by using a client application other than Lync 2010 will see a link that points them toward a download for Lync 2010 Attendee.

ShowJoinUsingLegacyClientLink

Optional

String

If set to True, users joining a meeting by using a client application other than Lync 2010 will be given the opportunity to join the meeting by using their current client application. The default value is False.

TrustedCACerts

Optional

Certificate collection

Collection of certificates representing certificate chains trusted by the Web server. New certificates added to the collection must be created using the New-CsWebTrustedCACertificate cmdlet.

This collection is not used if the InferCertChainFromSSL property is set to True.

UseCertificateAuth

Optional

Boolean

When set to True (the default value), clients can be authenticated using certificates. Set this value to False ($False) to disable certificate authentication.

UsePinAuth

Optional

Boolean

When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). Set this value to False ($False) to disable PIN authentication.

UseWindowsAuth

Optional

PS List Modifier

Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. Valid values are:

Negotiate – The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM).

NTLM – Windows authentication will be allowed, but only using the NTLM protocol.

None – Windows authentication will not be allowed.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might occur when running the command.

InMemory

Optional

Switch Parameter

Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.

WhatIf

Optional

Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Confirm

Optional

Switch Parameter

Prompts you for confirmation before executing the command.

None. New-CsWebServiceConfiguration does not accept pipelined input.

New-CsWebServiceConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object.

-------------------------- Example 1 ------------------------

New-CsWebServiceConfiguration -Identity site:Redmond -EnableGroupExpansion $False -UseCertificateAuth $True

The command shown in Example 1 creates a new collection of Web Services configuration settings for the Redmond site (-Identity site:Redmond). This example includes two optional parameters: EnableGroupExpansion, which is set to False ($False); and UseCertificateAuth, which is set to True ($True). These two parameters are used to disable group expansion and enable the use of certificates for authentication, respectively.

Note that this command will fail if a collection of Web Services configuration settings has already been created for the Redmond site. That’s because sites are limited to a single collection of Web Services configuration settings.

-------------------------- Example 2 ------------------------

$x = New-CsWebServiceConfiguration -Identity site:Redmond -InMemory
$x.EnableGroupExpansion = $False 
$x.UseCertificateAuth = $True
Set-CsWebServiceConfiguration -Instance $x

Example 2 is a variation of the command shown in Example 1; in this case, however, the new collection of Web Services configuration settings is initially created in memory only, and is only later applied to the Redmond site. In order to do this, the first command in the example uses New-CsWebServiceConfiguration to create a collection of settings for the Redmond site; the InMemory parameter is included to ensure that this collection is created in memory only and is not immediately applied to the Redmond site. (Because the settings exist only in memory, they must be stored in a variable. In this case, that’s a variable named $x.)

Commands 2 and 3 in the example take these virtual configuration settings and modify the values of the EnableGroupExpansion and UseCertificateAuth properties. After these changes have been made, the final command uses the Set-CsWebServiceConfiguration to take the virtual settings and apply them to the Redmond site. If you do not call Set-CsWebServiceConfiguration, no new settings will be assigned to the site. Instead, your virtual Web Services configuration settings will disappear as soon as you end your Windows PowerShell session or delete the variable $x.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft