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

Removes an existing collection of proxy server configuration settings.


Remove-CsProxyConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Xds Identity

Unique identifier of the proxy server configuration settings to be removed. For example, this syntax removes the proxy server settings applied to the Registrar service in the Redmond site: -Identity "service:Registrar:atl-cs-001.litwareinc.com".

Remove-CsProxyConfiguration can also be run against the global settings. In that case, however, the settings will not be removed. Instead, the properties within that global collection will all be reset to their default values.



Switch Parameter

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



Switch Parameter

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



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Proxy servers provide a way for users outside of your internal network to access resources on that network. Instead of providing these users with direct access to the internal network, however, these users access the proxy server, which acts as an intermediary between external users and the internal network.

Microsoft Communications Server 2010 enables you to manage your proxy servers through proxy server configuration settings. These settings, which can be applied at both the global scope and the service scope (albeit for only the Edge ServerEdge Server and Registrar services) enable you to control such things as the authentication protocols that can be used by client endpoints and whether or not compression will be used on incoming and outgoing proxy server connections. When you install Communications Server, a global collection of proxy server configuration settings is automatically created for you. As noted, you can also create additional collections at the service scope.

Any new proxy server settings you create can later be removed by using the Remove-CsProxyConfiguration cmdlet. Note that you can also run Remove-CsProxyConfiguration against the global collection. In that case, however, the global settings will not be removed because Communications Server does not allow you to remove global settings. Instead, all of the properties within the global collection will be reset to their default values. For example, by default proxy server settings allow clients to use the Kerberos protocol for authentication. You can change the global settings to disable the use of Kerberos. However, if you run Remove-CsProxyConfiguration against the global collection, the property in question (UseKerberosForClientToProxyAuth) will be reset to its default value, and Kerberos will again be enabled for use as an authentication protocol.

Return Types

Remove-CsProxyConfiguration deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object.


-------------------------- Examples 1 --------------------------

Copy Code
Remove-CsProxyConfiguration -Identity service: EdgeServer:atl-edge-011.litwareinc.com 

The command shown in Example 1 deletes the proxy configuration settings that have the Identity service:EdgeServer:atl-edge-litwareinc.com. Because Identities must be unique, this command will never delete more than one collection of proxy configuration settings.

-------------------------- Examples 2 --------------------------

Copy Code
Get-CsProxyConfiguration -Filter "service:*" | Remove-CsProxyConfiguration

In Example 2, all of the proxy configuration settings applied at the service scope are deleted. To accomplish this task, the command first calls Get-CsProxyConfiguration along with the Filter parameter. The filter value "service:*" ensures that only proxy settings that have an Identity that begins with the string value "service:" will be returned. That filtered collection is then piped to Remove-CsProxyConfiguration, which deletes each item in the collection.

-------------------------- Examples 3 --------------------------

Copy Code
Get-CsProxyConfiguration | Where-Object {$_.TreatAllClientsAsRemote -eq $True} | Remove-CsProxyConfiguration

The preceding command deletes any proxy configuration settings that treat all clients as remote clients. To do this, Get-CsProxyConfiguration is first called (without any parameters) in order to return a collection of all the proxy server configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the TreatAllClientsAsRemote property is equal to (-eq) True ($True). This subset of proxy configuration settings is then piped to Remove-CsProxyConfiguration, which removes all the settings where all clients are treated as remote clients.