Remove-CsNetworkSite

 

Topic Last Modified: 2012-03-26

Removes a network site that has been defined for call admission control (CAC) or Enhanced 9-1-1 (E9-1-1).

Syntax

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

Detailed Description

Network sites are the offices or locations configured within each region of a CAC or E9-1-1 deployment. This cmdlet removes a site from the CAC or E9-1-1 configuration.

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

Parameters

Parameter Required Type Description

Identity

Required

XdsGlobalRelativeIdentity

The unique identifier of the network site you want to remove. Sites are created only at the global scope, so you do not need to specify a scope. Instead, you need to specify only the site ID.

Force

Optional

SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

WhatIf

Optional

SwitchParameter

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

Confirm

Optional

SwitchParameter

Prompts you for confirmation before executing the command.

Input Types

Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType object. Accepts pipelined input of network site objects.

Return Types

This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType.

Example

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

Remove-CsNetworkSite -Identity Vancouver

This example removes the site with the Identity Vancouver from the CAC or E9-1-1 configuration.

-------------------------- Example 2 --------------------------

Get-CsNetworkSite | Where-Object {$_.BWPolicyProfileID -eq "LowBWProfile"} | Remove-CsNetworkSite

Example 2 removes all sites that are using the bandwidth policy profile named LowBWProfile from the CAC or E9-1-1 configuration. The example first calls Get-CsNetworkSite to retrieve all network sites. This collection of sites is piped to the Where-Object cmdlet, which narrows the collection to only those sites that have a BWPolicyProfileID equal to (-eq) LowBWProfile. This new collection is then piped to Remove-CsNetworkSite to remove those sites.