Topic Last Modified: 2013-02-21

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. This cmdlet was introduced in Lync Server 2010.


New-CsSipProxyCustom -CustomValue <String>



The command shown in Example 1 assigns a custom realm (Litwareinc Communications Service) to a variable named $x.

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

Detailed Description

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, Lync Server uses SIP Communications Service 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). You can create a custom realm by using the New-CsSipProxyCustom cmdlet.

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


Parameter Required Type Description




Name of the realm to be used for authentication purposes.

Input Types

None. The New-CsSipProxyCustom cmdlet does not accept pipelined input.

Return Types

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

See Also