Topic Last Modified: 2010-10-01
Creates a new SIP domain for use in your organization. SIP domains are domains authorized to send and receive SIP traffic, and are used when assigning SIP addresses to users.
Syntax
New-CsSipDomain -Identity
<XdsGlobalRelativeIdentity> [-Confirm
[<SwitchParameter>]] [-Force <SwitchParameter>]
[-IsDefault <$true | $false>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
String |
Fully qualified domain name (FQDN) for the new SIP domain. For example: -Identity fabrikam.com. |
IsDefault |
Optional |
Boolean |
Indicates whether the domain is the default SIP domain, the domain used by Lync Server 2010 any time a domain name is not explicitly stated. If set to True, the new domain will also become the new default domain The default value for IsDefault is False. If you do not want to make the new domain the default domain you can simply leave out the parameter. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur 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
In order to configure SIP addresses for your users (and thus enable them to use SIP-related software such as Microsoft Lync 2010), you need two pieces of information: a user ID (for example, Ken.Myer) and a SIP domain (for example, litwareinc.com). The SIP domain used to construct a SIP address must be a domain, located within your Active Directory forest, that is authorized to send and receive SIP traffic. For example, suppose you have domains named litwareinc.com, fabrikam.com, and contoso.com, but only litwareinc.com has been identified as being a SIP domain. In that case, you cannot use a SIP address like sip:Ken.Myer@fabrikam.com or sip:Ken.Myer@contoso.com, at least not until fabrikam.com and contoso.com have been configured as valid SIP domains. That is something you can do by running the New-CsSipDomain cmdlet.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsSipDomain 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-CsSipDomain"}
Input Types
None. New-CsSipDomain does not accept pipelined data.
Return Types
New-CsSipDomain creates new instances of the Microsoft.Rtc.Management.Xds.SipDomain object.
Example
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
New-CsSipDomain -Identity fabrikam.com |
The command shown in Example 1 creates a new SIP domain, one that has the Identity fabrikam.com.
-------------------------- Example 2 ------------------------
Copy Code | |
---|---|
New-CsSipDomain -Identity fabrikam.com -IsDefault $True |
The preceding command creates a new SIP domain named fabrikam.com and makes this new domain the default SIP domain. By making fabrikam.com the default domain, this command also "demotes" the domain that previously served as the default SIP domain. That’s because you can have only one default SIP domain.