Get-CsProxyConfiguration

Syntax

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

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

Description

Skype for Business Server 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 Skype for Business 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 of the proxy server configuration settings currently in use in your organization.

Examples

-------------------------- 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 the Get-CsProxyConfiguration cmdlet 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:*"

Example 3 returns information about all of the proxy settings that have been configured at the service scope. To do this, the command calls the Get-CsProxyConfiguration cmdlet 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 the Get-CsProxyConfiguration cmdlet 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}

Example 5 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 the Get-CsProxyConfiguration cmdlet without any parameters; this returns a collection of all the proxy configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which picks out those settings where the MaxClientMessageBodySizeKb property is less than 5000 kilobytes.

Parameters

-Filter

-Identity

-LocalStore

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings

Related Links

• New-CsProxyConfiguration
• Remove-CsProxyConfiguration
• Set-CsProxyConfiguration