New-CsSipProxyRealm
Topic Last Modified: 2012-03-27
Used to assign the default 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-CsSipProxyRealm -RealmChoice <IRealmChoice>
Detailed Description
Proxy servers provide a way for users outside your internal network to access resources on your 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 Lync Server 2010 uses SIP Communications Service as its default realm; however, it is possible to change the realm used by a proxy server. The New-CsSipProxyUseDefault and New-CsSipProxyCustom cmdlets provide a way for you to change the realm used by a proxy server. These changes can also be made by using New-CsSipProxyRealm. However, because this cmdlet requires an additional step you might want to use the other two cmdlets any time you need to change the realm used by a proxy server.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsSipProxyRealm 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-CsSipProxyRealm"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
RealmChoice |
Required |
SipProxy.IRealmChoice object |
Object representing the realm to be used by a proxy server. The RealmChoice must be created by using either the New-CsSipProxyUseDefault or the New-CsSipProxyCustom cmdlet. |
Input Types
None. New-CsSipProxyRealm does not accept pipelined input.
Return Types
New-CsSipProxyRealm creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Realm object.
Example
-------------------------- Example 1 ------------------------
$x = New-CsSipProxyUseDefault
$y = New-CsSipProxyRealm -RealmChoice $x
The commands shown in Example 1 assign the default realm (SIP Communications Service) to a variable named $y. To do this, the first command calls New-CsSipProxyUseDefault in order to create a SipProxy.UseDefault object; this object is stored in a variable named $x.
In the second command, $x is used as the parameter value for New-CsSipProxyRealm and the RealmChoice parameter. In turn, this creates a new proxy realm object that is stored in a variable named $y.
-------------------------- Example 2 ------------------------
$x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service"
$y = New-CsSipProxyRealm -RealmChoice $x
The commands shown in Example 2 assign a custom realm (Litwareinc Communications Service) to a variable named $y. To do this, the first command calls New-CsSipProxyCustom in order to create a SipProxy.Custom object; this object (which uses the CustomValue Litwareinc Communications Service) is stored in a variable named $x.
In the second command, $x is used, along with the New-CsSipProxyRealm cmdlet and the RealmChoice parameter, to create a new custom realm object.