Topic Last Modified: 2013-02-21
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. This cmdlet was introduced in Lync Server 2010.
Syntax
New-CsSipDomain -Identity
<XdsGlobalRelativeIdentity> [-Confirm
[<SwitchParameter>]] [-Force <SwitchParameter>]
[-IsDefault <$true | $false>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
The command shown in Example 1 creates a new SIP domain, one that has the Identity fabrikam.com.
Copy Code | |
---|---|
New-CsSipDomain -Identity fabrikam.com |
EXAMPLE 2
Example 2 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.
Copy Code | |
---|---|
New-CsSipDomain -Identity fabrikam.com -IsDefault $True |
Detailed Description
In order to configure SIP addresses for your users (and thus enable them to use SIP-related software such as Lync 2013), 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"}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Rtc.Management.Xds.XdsGlobalRelativeIdentity |
Fully qualified domain name (FQDN) for the new SIP domain. For example: -Identity fabrikam.com. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
IsDefault |
Optional |
System.Boolean |
Indicates whether the domain is the default SIP domain, the domain used by Lync Server 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. If you change the default SIP domain you will need to restart the RTCCAA and RTCCAS services. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
None. The New-CsSipDomain cmdlet does not accept pipelined data.
Return Types
The New-CsSipDomain cmdlet reates new instances of the Microsoft.Rtc.Management.Xds.SipDomain object.