Edit

Share via


New-CsSipDomain

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

Default (Default)

New-CsSipDomain
    [-Identity] <XdsGlobalRelativeIdentity>
    [-IsDefault <Boolean>]
    [-Force]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

In order to configure SIP addresses for your users (and thus enable them to use SIP-related software such as Skype for Business), 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.

Examples

EXAMPLE 1


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


New-CsSipDomain -Identity fabrikam.com -IsDefault $True

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.

Parameters

-Confirm

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Prompts you for confirmation before executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Suppresses the display of any non-fatal error message that might occur when running the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Fully qualified domain name (FQDN) for the new SIP domain. For example:

-Identity fabrikam.com

Parameter properties

Type:XdsGlobalRelativeIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsDefault

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Indicates whether the domain is the default SIP domain, the domain used by Skype for Business 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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Describes what would happen if you executed the command without actually executing the command.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

The New-CsSipDomain cmdlet does not accept pipelined data.

Outputs

Microsoft.Rtc.Management.Xds.SipDomain

The New-CsSipDomain cmdlet creates new instances of the Microsoft.Rtc.Management.Xds.SipDomain object.