Edit

Share via

Remove-CsSipDomain

Module:
Skype for Business Server PowerShell

Removes a SIP ___domain previously configured 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) 

Remove-CsSipDomain
    [-Identity] <XdsGlobalRelativeIdentity>
    [-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. This is something you can do by running the New-CsSipDomain cmdlet.

After a SIP ___domain has been authorized, it can be "unauthorized" by using the Remove-CsSipDomain cmdlet. This cmdlet removes the specified ___domain from the list of approved SIP domains. Note, however, that you cannot remove the default ___domain; if you need to do this, you will first have to configure another SIP ___domain to act as the default ___domain. If you only have one SIP ___domain, that ___domain will automatically be configured as the default ___domain and you will not be able to remove it.

In addition, you cannot remove any SIP ___domain that has one or more SIP addresses assigned to it. For example, you cannot remove Contoso.com as a SIP ___domain if Ken Myer has the SIP address "sip:kenmyer@contoso.com". To remove a SIP ___domain currently in use, you must first assign new SIP addresses to all the users who have that ___domain in their SIP address.

Examples

Example 1

Remove-CsSipDomain -Identity fabrikam.com

Example 1 removes the SIP ___domain with the Identity fabrikam.com from the list of supported ___domain names. Note that this command will fail if fabrikam.com is the only SIP ___domain currently in use in your organization. That's because your topology must include at least one SIP ___domain.

Example 2

Get-CsSipDomain | Where-Object {$_.IsDefault -ne $True} | Remove-CsSipDomain

The command shown in Example 2 deletes all the SIP domains in your organization except for the default ___domain. To do this, the command first calls the Get-CsSipDomain cmdlet in order to return a collection of all your SIP domains. This collection is then piped to the Where-Object cmdlet, which picks out only those domains where the IsDefault property is not equal to True. The net effect: the default ___domain is filtered out and the remaining domains are then piped to the Remove-CsSipDomain cmdlet and deleted.

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) of the SIP ___domain to be removed: 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:True
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

Microsoft.Rtc.Management.Xds.SipDomain

The Remove-CsSipDomain cmdlet accepts pipelined instances of the SIP ___domain object.

Outputs

None

Instead, the Remove-CsSipDomain cmdlet deletes existing instance of the Microsoft.Rtc.Management.Xds.SipDomain object.