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> |
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 using either the New-CsSipProxyUseDefault or the New-CsSipProxyCustom cmdlets. |
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. 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 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.
Return Types
New-CsSipProxyRealm creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.SipProxy.Realm object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
$x = New-CsSipProxyUseDefault $y = New-CsSipProxyRealm -RealmChoice $x Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -Realm $y |
|
The commands shown in Example 1 assign the default realm (SIP Communications Service) to the proxy configuration settings for the service EdgeServer:atl-edge-001.litwareinc.com. 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. The variable $y and the –Realm parameter are then used in conjunction with the Set-CsProxyConfiguration to assign the default realm to the proxy configuration settings for the service EdgeServer:atl-edge-001.litwareinc.com.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
$x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service" $y = New-CsSipProxyRealm -RealmChoice $x Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -Realm $x |
|
The commands shown in Example 2 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 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. After that, Set-CsProxyConfiguration is called in order to assign the custom realm to the proxy configuration settings for the service EdgeServer:atl-edge-001.litwareinc.com.