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

Returns information about the proxy server configuration settings currently in use in your organization.

Syntax


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


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

Parameters

Parameter	Required	Type	Description
Identity	Optional	Xds Identity	Unique identifier for the proxy server configuration settings to be returned. To return the global settings, use this syntax: -Identity global. To return settings configured at the service scope, use syntax similar to this: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com". Note that you cannot use wildcards when specifying an Identity. If you want to (or need to) use wildcards, use the Filter parameter instead. If this parameter is not included, Get-CsProxyConfiguration returns all of the proxy server settings currently in use in your organization.
Filter	Optional	String	Enables you to use wildcards when specifying the proxy configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope: -Filter "service:*". You cannot use both the Filter and the Identity parameters in the same command.
LocalStore	Optional	Switch Parameter

Parameter

Required

Type

Description

Identity

Optional

Xds Identity

Unique identifier for the proxy server configuration settings to be returned. To return the global settings, use this syntax: -Identity global. To return settings configured at the service scope, use syntax similar to this: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com". Note that you cannot use wildcards when specifying an Identity. If you want to (or need to) use wildcards, use the Filter parameter instead.

If this parameter is not included, Get-CsProxyConfiguration returns all of the proxy server settings currently in use in your organization.

Filter

Optional

String

Enables you to use wildcards when specifying the proxy configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope: -Filter "service:*".

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

LocalStore

Optional

Switch Parameter

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.

The Get-CsProxyConfiguration cmdlet enables you to return information about any (or all) of the proxy server configuration settings currently in use in your organization.

Return Types

Get-CsProxyConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SipProxy.ProxySettings object.

Examples

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

	Copy Code
Get-CsProxyConfiguration

The command shown in Example 1 returns a collection of all the proxy configuration settings currently in use in the organization. This is done by calling Get-CsProxyConfiguration without any parameters.

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

	Copy Code
Get-CsProxyConfiguration -Identity "service:EdgeServer:atl-cs-001.litwareinc.com"

In Example 2, information about the proxy configuration settings that have the Identity service:Redmond-EdgeServer-1 is returned. Because Identities must be unique, this command will never return more than one collection of settings.

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

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

The preceding command returns information about all of the proxy settings that have been configured at the service scope. To do this, the command calls Get-CsProxyConfiguration along with the Filter parameter; the filter value "service:*" ensures that only those settings that have an Identity that begins with the string value "service:" will be returned.

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

	Copy Code
Get-CsProxyConfiguration \| Where-Object {$_.UseCertificateForClientToProxyAuth -eq $False}

Example 4 returns information about the proxy configuration settings that do not allow the use of client certificates as an authentication mechanism. To carry out this task, the command first uses Get-CsProxyConfiguration to return a collection of all the proxy configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the UseCertificateForClientToProxyAuth property is equal to (-eq) False ($False).

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

	Copy Code
Get-CsProxyConfiguration \| Where-Object {$_.MaxClientMessageBodySizeKb -lt 5000}

The preceding command returns all the proxy configuration settings where the maximum body size for a client message is less than 5000 kilobytes. To do this, the command first calls Get-CsProxyConfiguration without any parameters; this returns a collection of all the proxy configuration settings currently in use. This collection is then piped to Where-Object, which picks out those settings where the MaxClientMessageBodySizeKb property is less than (-lt) 5000 kilobytes.