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

Modifies an existing collection of proxy server configuration settings.

Syntax


Set-CsProxyConfiguration [-Identity <XdsIdentity>] [-AcceptClientCompression <$true \| $false>] [-AcceptServerCompression <$true \| $false>] [-Confirm [<SwitchParameter>]] [-DisableNtlmFor2010AndLaterClients <$true \| $false>] [-EnableWhiteSpaceKeepAlive <$true \| $false>] [-Force <SwitchParameter>] [-MaxClientCompressionKb <UInt32>] [-MaxClientMessageBodySizeKb <UInt32>] [-MaxServerCompressionKb <UInt32>] [-MaxServerMessageBodySizeKb <UInt32>] [-Realm <IRealmChoice>] [-RequestServerCompression <$true \| $false>] [-TreatAllClientsAsRemote <$true \| $false>] [-UseCertificateForClientToProxyAuth <$true \| $false>] [-UseKerberosForClientToProxyAuth <$true \| $false>] [-UseNtlmForClientToProxyAuth <$true \| $false>] [-WhatIf [<SwitchParameter>]]

Set-CsProxyConfiguration [-Identity <XdsIdentity>] [-AcceptClientCompression <$true | $false>] [-AcceptServerCompression <$true | $false>] [-Confirm [<SwitchParameter>]] [-DisableNtlmFor2010AndLaterClients <$true | $false>] [-EnableWhiteSpaceKeepAlive <$true | $false>] [-Force <SwitchParameter>] [-MaxClientCompressionKb <UInt32>] [-MaxClientMessageBodySizeKb <UInt32>] [-MaxServerCompressionKb <UInt32>] [-MaxServerMessageBodySizeKb <UInt32>] [-Realm <IRealmChoice>] [-RequestServerCompression <$true | $false>] [-TreatAllClientsAsRemote <$true | $false>] [-UseCertificateForClientToProxyAuth <$true | $false>] [-UseKerberosForClientToProxyAuth <$true | $false>] [-UseNtlmForClientToProxyAuth <$true | $false>] [-WhatIf [<SwitchParameter>]]


Set-CsProxyConfiguration [-AcceptClientCompression <$true \| $false>] [-AcceptServerCompression <$true \| $false>] [-Confirm [<SwitchParameter>]] [-DisableNtlmFor2010AndLaterClients <$true \| $false>] [-EnableWhiteSpaceKeepAlive <$true \| $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaxClientCompressionKb <UInt32>] [-MaxClientMessageBodySizeKb <UInt32>] [-MaxServerCompressionKb <UInt32>] [-MaxServerMessageBodySizeKb <UInt32>] [-Realm <IRealmChoice>] [-RequestServerCompression <$true \| $false>] [-TreatAllClientsAsRemote <$true \| $false>] [-UseCertificateForClientToProxyAuth <$true \| $false>] [-UseKerberosForClientToProxyAuth <$true \| $false>] [-UseNtlmForClientToProxyAuth <$true \| $false>] [-WhatIf [<SwitchParameter>]]

Set-CsProxyConfiguration [-AcceptClientCompression <$true | $false>] [-AcceptServerCompression <$true | $false>] [-Confirm [<SwitchParameter>]] [-DisableNtlmFor2010AndLaterClients <$true | $false>] [-EnableWhiteSpaceKeepAlive <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-MaxClientCompressionKb <UInt32>] [-MaxClientMessageBodySizeKb <UInt32>] [-MaxServerCompressionKb <UInt32>] [-MaxServerMessageBodySizeKb <UInt32>] [-Realm <IRealmChoice>] [-RequestServerCompression <$true | $false>] [-TreatAllClientsAsRemote <$true | $false>] [-UseCertificateForClientToProxyAuth <$true | $false>] [-UseKerberosForClientToProxyAuth <$true | $false>] [-UseNtlmForClientToProxyAuth <$true | $false>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	Xds Identity	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:Redmond-EdgeServer-1". If this parameter is not included, Set-CsProxyConfiguration will automatically modify the global settings.
Instance	Optional	ProxySettings object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
Realm	Optional	SipProxy object	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.
MaxClientMessageBodySizeKB	Optional	Integer	The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. The default value is 128; messages with a body size larger than 128 KB will be rejected.
MaxServerMessageBodySizeKB	Optional	Integer	The maximum-allowed size (in kilobytes) for the body of a message sent from another server. The default value is 5000; messages with a body size larger than 5000 KB will be rejected.
TreatAllClientsAsRemote	Optional	Boolean	When set to True, the proxy server functions as if all client connections are external connections that pass through the Access Edge server. The default value is False.
EnableWhiteSpaceKeepAlive	Optional	Boolean	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 their connection is still active.
UseKerberosForClientToProxyAuth	Optional	Boolean	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 domain than the server.
UseNtlmForClientToProxyAuth	Optional	Boolean	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.
UseCertificateForClientToProxyAuth	Optional	Boolean	When set to True (the default value), client endpoints will be allowed to use certificates for authentication.
DisableNTLMFor2010AndLaterClients	Optional	Boolean	When set to True, users logging on from Microsoft Communicator "14" must use the Kerberos protocol for authentication. The default value is False.
AcceptClientCompression	Optional	Boolean	When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints.
MaxClientCompressionKb	Optional	Integer	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 default value is 15000.
AcceptServerCompression	Optional	Boolean	When set to True (the default value), the proxy server will accept all incoming compression requests from other servers.
MaxServerCompressionKb	Optional	Integer	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 default value is 1024.
RequestServerCompression	Optional	Boolean	When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers.
Force	Optional	Switch Parameter	Suppresses the display of any non-fatal error message that might arise when running the command.
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional	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.nm-ocs-14-1st

The Set-CsProxyConfiguration cmdlet provides a way for you to modify the property values of an existing collection of proxy server configuration settings.

Return Types

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

Examples

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

	Copy Code
Set-CsProxyConfiguration -Identity service:Redmond-EdgeServer-1 -AcceptServerCompression $True

In Example 1, the proxy configuration settings that have the Identity service:Redmond-EdgeServer-1 are modified to accept server compression. This is done by calling Set-CsProxyConfiguration and the AcceptServerCompression parameter, and by setting the parameter value to True ($True).

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

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

The preceding command locates all of the proxy configuration settings that accept server compressions, and then modifies these settings to accept client compression as well. To do this, the command first calls Get-CsProxyConfiguration 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 (-eq) True ($True). This filtered collection is then piped to Set-CsProxyConfiguration, which takes each item in the collection and sets the AcceptClientCompression property to True.

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

	Copy Code
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 Get-CsProxyConfiguration 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 Set-CsProxyConfiguration, which takes each item in tje collection and sets the UseNtlmForClientToProxyAuth property to False ($False).