Edit

Share via

Set-CsProxyConfiguration

Module:
Skype for Business Server PowerShell

Modifies an existing collection of proxy server configuration settings. This cmdlet was introduced in Lync Server 2010.

Syntax

Identity 

Set-CsProxyConfiguration
    [[-Identity] <XdsIdentity>]
    [-AcceptClientCompression <Boolean>]
    [-AcceptServerCompression <Boolean>]
    [-EnableWhiteSpaceKeepAlive <Boolean>]
    [-MaxClientCompressionCount <UInt32>]
    [-MaxServerCompressionCount <UInt32>]
    [-Realm <IRealmChoice>]
    [-RequestServerCompression <Boolean>]
    [-TreatAllClientsAsRemote <Boolean>]
    [-UseCertificateForClientToProxyAuth <Boolean>]
    [-UseKerberosForClientToProxyAuth <Boolean>]
    [-UseNtlmForClientToProxyAuth <Boolean>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [-DisableNtlmFor2010AndLaterClients <Boolean>]
    [-DnsCacheRecordCount <UInt32>]
    [-MaxClientMessageBodySizeKb <UInt32>]
    [-MaxServerMessageBodySizeKb <UInt32>]
    [-OutgoingTlsCount <UInt32>]
    [-AllowPartnerPollingSubscribes <Boolean>]
    [-EnableLoggingAllMessageBodies <Boolean>]
    [-LoadBalanceEdgeServers <Boolean>]
    [-LoadBalanceInternalServers <Boolean>]
    [-MaxKeepAliveInterval <UInt32>]
    [-SpecialConfigurationList <String>]
    [-TestFeatureList <String>]
    [-TestParameterList <String>]
    [<CommonParameters>]

Instance 

Set-CsProxyConfiguration
    [-Instance <PSObject>]
    [-AcceptClientCompression <Boolean>]
    [-AcceptServerCompression <Boolean>]
    [-EnableWhiteSpaceKeepAlive <Boolean>]
    [-MaxClientCompressionCount <UInt32>]
    [-MaxServerCompressionCount <UInt32>]
    [-Realm <IRealmChoice>]
    [-RequestServerCompression <Boolean>]
    [-TreatAllClientsAsRemote <Boolean>]
    [-UseCertificateForClientToProxyAuth <Boolean>]
    [-UseKerberosForClientToProxyAuth <Boolean>]
    [-UseNtlmForClientToProxyAuth <Boolean>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [-DisableNtlmFor2010AndLaterClients <Boolean>]
    [-DnsCacheRecordCount <UInt32>]
    [-MaxClientMessageBodySizeKb <UInt32>]
    [-MaxServerMessageBodySizeKb <UInt32>]
    [-OutgoingTlsCount <UInt32>]
    [-AllowPartnerPollingSubscribes <Boolean>]
    [-EnableLoggingAllMessageBodies <Boolean>]
    [-LoadBalanceEdgeServers <Boolean>]
    [-LoadBalanceInternalServers <Boolean>]
    [-MaxKeepAliveInterval <UInt32>]
    [-SpecialConfigurationList <String>]
    [-TestFeatureList <String>]
    [-TestParameterList <String>]
    [<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 Set-CsProxyConfiguration cmdlet provides a way for you to modify the property values of an existing collection of proxy server configuration settings.

Examples

Example 1

Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -AcceptServerCompression $True

In Example 1, all the proxy configuration settings that have the Identity service:EdgeServer:atl-edge-001.litwareinc.com are modified to accept server compression. This is done by calling the Set-CsProxyConfiguration cmdlet and the AcceptServerCompression parameter, and by setting the parameter value to True.

Example 2

Get-CsProxyConfiguration | Where-Object {$_.AcceptServerCompression -eq $True} | Set-CsProxyConfiguration -AcceptClientCompression $True

Example 2 locates all of the proxy configuration settings that accept server compression and then modifies these settings to accept client compression as well. To do this, the command first calls the Get-CsProxyConfiguration cmdlet without any parameters in order to return a collection of all the proxy settings in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the AcceptServerCompression property is equal to True. The filtered collection is then piped to the Set-CsProxyConfiguration cmdlet, which takes each item in the collection and sets the AcceptClientCompression property to True.

Example 3

Get-CsProxyConfiguration -Filter service:* | Set-CsProxyConfiguration -UseNtlmForClientToProxyAuth $False

Example 3 shows how you can modify all of the proxy settings that have been configured at the service scope. In order to do this, the command first calls the Get-CsProxyConfiguration cmdlet and includes the Filter parameter; the filter value "service:*" ensures that only settings that have an Identity that begins with the string value "service:" are returned. The filtered collection is then piped to the Set-CsProxyConfiguration cmdlet, which takes each item in the collection and sets the UseNtlmForClientToProxyAuth property to False.

Parameters

-AcceptClientCompression

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AcceptServerCompression

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value), the proxy server will accept all incoming compression requests from other servers.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowPartnerPollingSubscribes

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set the True, partner applications are allowed to periodically poll the service for state changes. The default value is False ($False).

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableNtlmFor2010AndLaterClients

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. The default value is False.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DnsCacheRecordCount

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Maximum number of records that can be maintained in the DNS record cache. The default value is 3000.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableLoggingAllMessageBodies

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True, Skype for Business Server will log the actual content of all instant messages. For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files.

The default value is False.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableWhiteSpaceKeepAlive

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value) the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Unique identifier for the proxy server configuration settings to be modified. To modify the global settings, use this syntax:

-Identity global

To modify settings configured at the service scope, use syntax similar to this:

-Identity "service: EdgeServer:atl-edge-001.litwareinc.com"

If this parameter is not included, the Set-CsProxyConfiguration cmdlet will automatically modify the global settings.

Parameter properties

Type:XdsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Instance

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Instance
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-LoadBalanceEdgeServers

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When True, software load balancing is employed for requests to Edge Servers. The default value is True ($True).

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LoadBalanceInternalServers

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When True, software load balancing is employed for requests to Registrars and other internal servers. The default value is true ($True).

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxClientCompressionCount

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. The compression count can be set to any integer value between 0 and 65535, inclusive. The default value is 15000.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxClientMessageBodySizeKb

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. The client message body size can be set to any integer value between 64 and 256, inclusive.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxKeepAliveInterval

Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. The default value is 20 minutes.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxServerCompressionCount

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. The server compression count can be set to any integer value between 0 and 65535, inclusive. The default value is 1024.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxServerMessageBodySizeKb

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

The maximum-allowed size (in kilobytes) for the body of a message sent from another server. The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. The server message body size can be set to any integer value between 1000 and 20000, inclusive.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OutgoingTlsCount

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. The minimum number of TLS connections is 1, and the maximum number is 4. By default, OutgoingTlsCount is set to 4.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Realm

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communication Services) or by a custom realm. Custom realms must be specified (and created) by using the New-CsSipProxyCustom cmdlet.

Parameter properties

Type:IRealmChoice
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestServerCompression

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SpecialConfigurationList

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

PARAMVALUE: String

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TestFeatureList

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

This parameter is not currently used by Skype for Business Server.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TestParameterList

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

This parameter is not currently used by Skype for Business Server.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TreatAllClientsAsRemote

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server. The default value is False.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseCertificateForClientToProxyAuth

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value), client endpoints will be allowed to use certificates for authentication.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseKerberosForClientToProxyAuth

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseNtlmForClientToProxyAuth

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. That is not the case with Kerberos authentication.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

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

The Set-CsProxyConfiguration cmdlet accepts pipelined instances of the proxy settings object.

Outputs

None

The Set-CsProxyConfiguration cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object.