[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about all the Web service configuration settings in use in your organization.

Syntax


Get-CsWebServiceConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]


Get-CsWebServiceConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Parameters

Parameter	Required	Type	Description
Identity	Optional	Xds Identity	Unique identifier for the Web service configuration settings to be returned. To return the global settings, use this syntax: -Identity global. To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond." Service-scope settings can be returned using syntax like this: -Identity "service:WebServer:atl-cs-001.litwareinc.com". You cannot use both Filter and Identity in the same command. If you do not specify either parameter, Get-CsWebServiceConfiguration will return all the Web service settings collections currently in use in your organization.
Filter	Optional	String	Enables you to use wildcards when specifying the Web service configuration settings collection (or collections) to be removed. For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". You cannot use both Filter and Identity in the same command.
LocalStore	Optional	Switch Parameter

Parameter

Required

Type

Description

Identity

Optional

Xds Identity

Unique identifier for the Web service configuration settings to be returned. To return the global settings, use this syntax: -Identity global. To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond." Service-scope settings can be returned using syntax like this: -Identity "service:WebServer:atl-cs-001.litwareinc.com".

You cannot use both Filter and Identity in the same command. If you do not specify either parameter, Get-CsWebServiceConfiguration will return all the Web service settings collections currently in use in your organization.

Filter

Optional

String

Enables you to use wildcards when specifying the Web service configuration settings collection (or collections) to be removed. For example, this syntax returns all the settings configured at the site scope: -Filter "site:*".

You cannot use both Filter and Identity in the same command.

LocalStore

Optional

Switch Parameter

Detailed Description

Many Microsoft Communications Server 2010components are Web-based: these components either use Web services or Web pages 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 Communications Server Control Panel use Web pages as the interface between Communications Server 2010 and users.

The CsWebServiceConfiguration cmdlets enable administrators to manage Web service 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 the only the WebServer service), you can customize Web service capabilities for different users and different locations.

The Get-CsWebServiceConfiguration cmdlet enables you to return detailed information about the Web service configuration settings currently in use in your organization.

Return Types

Get-CsWebServiceConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Web.WebServiceSettings object.

Examples

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

	Copy Code
Get-CsWebServiceConfiguration

The preceding command returns information about all the Web service configuration settings currently in use in the organization.

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

	Copy Code
Get-CsWebServiceConfiguration -Identity site:Redmond

The command shown in Example 2 returns information about the Web service configuration settings that have the Identity site:Redmond.

-------------------------- Example 3 ------------------------

	Copy Code
Get-CsWebServiceConfiguration -Filter "site:*"

Example 3 returns all the Web service configurations settings that have been assigned at the site scope. To do this, the Filter parameter is included when calling Get-CsWebServiceConfiguration; the filter value "site:*" ensures that only those settings that have an Identity that begins with the string value "site:" are returned.

-------------------------- Example 4 ------------------------

	Copy Code
Get-CsWebServiceConfiguration \| Where-Object {$_.UsePinAuth -eq $False}

In Example 4, the command returns all the Web service configuration settings that do not allow PIN authentication. This is done by first calling Get-CsWebServiceConfiguration to return all the Web service configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the UsePinAuth property is equal to (-eq) False ($False).

-------------------------- Example 5 ------------------------

	Copy Code
Get-CsWebServiceConfiguration \| Where-Object {$_.MaxGroupSizeToExpand -gt 100}

The preceding command returns all the Web service configuration settings where the maximum group expansion size is greater than 100. To do this, the command first uses Get-CsWebServiceConfiguration to return all the Web service configuration settings currently in use. This information is then piped to the Where-Object cmdlet, which selects only those settings where the MaxGroupSizeToExpand property is greater than (-gt) 100.