Remove-CsSipDomain

Syntax

Remove-CsSipDomain -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

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. 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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-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 "Remove-CsSipDomain"}

Parameters

Input Types

Microsoft.Rtc.Management.Xds.SipDomain object. Remove-CsSipDomain accepts pipelined instances of the SIP domain object.

Return Types

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

Example

-------------------------- Example 1 ------------------------

Remove-CsSipDomain -Identity fabrikam.com

The preceding command 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 Get-CsSipDomain 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 Remove-CsSipDomain and deleted.

See Also

Other Resources

Get-CsSipDomain
New-CsSipDomain
Set-CsSipDomain