Product Documentation

Remove-BrokerScope

Apr 15, 2014

Remove the specified catalog/desktop group from the given scope(s).

Syntax

Remove-BrokerScope [-InputObject] <Scope[]> [-Catalog <Catalog>] [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Remove-BrokerScope cmdlet is used to remove a catalog/desktop group object from the given scope(s).

To remove a catalog/desktop group from a scope you need permission to change the scopes of the catalog/desktop group.

If the catalog/desktop group is not in a specified scope, that scope will be silently ignored.

Related topics

Parameters

-InputObject<Scope[]>

Specifies the scopes to remove the object from.

Required? true
Default Value null
Accept Pipeline Input? true (ByValue)

-Catalog<Catalog>

Specifies the catalog object to be removed.

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-DesktopGroup<DesktopGroup>

Specifies the desktop group object to be removed.

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.Scope You can pipe scopes to Remove-BrokerScope.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Remove-BrokerScope -Scope Chalfont,Cambourne -DesktopGroup "Win7 Desktops"

Removes the "Win7 Desktops" desktop group from both the Chalfont and Cambourne scopes.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> 'Chalfont','Cambourne' | Remove-BrokerScope -DesktopGroup 'Win7 Desktops'

Removes the "Win7 Desktops" desktop group from both the Chalfont and Cambourne scopes.