Removes one or more collections of Web service configuration settings.
Syntax
Remove-CsWebServiceConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Xds Identity |
Unique identifier for the Web service configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". To remove settings configured at the service scope, use syntax similar to this: -Identity "service:WebServer:atl-cs-001.litwareinc.com". Remove-CsWebServiceConfiguration can also be run against the global collection. In that case, however, the global collection will not be removed; instead, all the properties in that collection will be reset to their default values. To reset the global collection, use this syntax: -Identity global. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Switch Parameter |
Prompts you for confirmation before executing the command. |
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.
If you create custom Web service configuration settings at the site or service scope these settings can later be removed by using the Remove-CsWebServiceConfiguration cmdlet. Note that you can also run Remove-CsWebServiceConfiguration against the global collection of Web service settings. In that case, however, the global collection will not be removed; that’s because Communications Server does not allow you to remove global settings. Instead, all the properties in the global collection will revert to their default values. For example, suppose you have changed the MaxGroupSizeToExpand value to 500. Because the default value for this property is 100, "removing" the global collection will reset the value of the MaxGroupSizeToExpand property to 100.
Return Types
Remove-CsWebServicesConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object.
Examples
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Remove-CsWebServiceConfiguration -Identity site:Redmond |
The preceding command removes the Web service configuration settings for the Redmond site. After these settings are removed, Web services in the Redmond site will automatically begin to use the global configuration settings.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
Get-CsWebServiceConfiguration -Filter "site:*" | Remove-CsWebServiceConfiguration |
In Example 2, all the Web service settings configured at the site scope are removed. To carry out this task, the command first calls Get-CsWebServiceConfiguration and includes the Filter parameter; the filter value "site:*" ensures that only those settings that have an Identity that begins with the characters "site:" are returned. This filtered collection is then piped to Remove-CsWebServiceConfiguration, which deletes each item in the collection.
-------------------------- Example 3 ------------------------
Copy Code | |
---|---|
Get-CsWebServiceConfiguration | Where-Object {$_.EnableGroupExpansion -eq $False} | Remove-CsWebServiceConfiguration |
The command shown in Example 3 deletes all the Web service configuration settings where group expansion has been disabled. To do this, the command first calls Get-CsWebServiceConfiguration without any parameters in order to return a collection of all the Web service configuration settings used in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the EnableGroupExpansion property is equal to (-eq) False ($False). The filtered collection is subsequently piped to Remove-CsWebServiceConfiguration, which deletes each item in the collection.