Share via

  • Article

Get-CsProxyConfiguration

 

Topic Last Modified: 2012-03-23

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>]

Detailed Description

Microsoft Lync 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 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 Lync Server 2010, 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 of the proxy server configuration settings currently in use in your organization.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsProxyConfiguration cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsProxyConfiguration"}

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

Retrieves the proxy configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsProxyConfiguration does not accept pipelined input.

Return Types

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

Example

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

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 --------------------------

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

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

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

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 --------------------------

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 False.

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

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 5000 kilobytes.