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

Used to assign a custom realm (SIP Communications Service) to a collection of proxy configuration settings. Realms (also known as protection domains) are used to authenticate user credentials during logon.

Syntax

New-CsSipProxyCustom -CustomValue <String>

Parameters

Parameter Required Type Description

CustomValue

Required

String

Name of the realm to be used for authentication purposes.

Detailed Description

Proxy servers provide a way for users outside your internal network to access resources on your internal network. Instead of providing direct access to the internal network, these users access the proxy server, which acts as an intermediary between the external users and the internal network.

Each proxy server must be associated with a realm; realms (also known as protection domains) indicate where a user’s logon credentials should be processed. By default, Microsoft Communications Server 2010 uses SIP Communications Server as its default realm; however, it is possible to change the realm used by a proxy server. This is done by creating a SipProxy.Custom object and then assigning that object to the Realm property of the appropriate proxy server (or servers).

Return Types

New-CsSipProxyCustom creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SipProxy.Custom object.

Examples

Add code example

Copy Code
$x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service"

Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -Realm $x

The commands shown in Example 1 assign a custom realm (Litwareinc Communications Service) to the proxy configuration settings for the service EdgeServer:atl-edge-001.litwareinc.com. To do this, the first command calls New-CsSipProxyCustom in order to create a SipProxy.Custom object; this object (which uses the custom value "Litwareinc Communications Service") is stored in a variable named $x. In the second command, this variable, and the –Realm parameter, are used in conjunction with the Set-CsProxyConfiguration to assign the custom realm to the proxy configuration settings for the service EdgeServer:atl-edge-001.litwareinc.com.