Citrix Virtual Apps and Desktops SDK

Remove-BrokerScope

June 30, 2023

Contributed by:

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

Syntax

Remove-BrokerScope [-InputObject] <Scope[]> [-ApplicationGroup <ApplicationGroup>] [-Catalog <Catalog>] [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The Remove-BrokerScope cmdlet is used to remove a scopeable object object from the given scope(s). A scopeable object is one of:

a catalog
a desktop group
an application group

To remove a scopeable object from a scope you need permission to change the scopes of the scopeable object.

If the scopeable object is not in a specified scope, that scope will be silently ignored.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Specifies the scopes to remove the object from.	true	true (ByValue)	null
ApplicationGroup	Specifies the application group object to be removed.	false	true (ByValue)
Catalog	Specifies the catalog object to be removed.	false	true (ByValue)
DesktopGroup	Specifies the desktop group object to be removed.	false	true (ByValue)
LoggingId	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.	false	false
AdminAddress	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.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false

Input Type

Citrix.Broker.Admin.Sdk.Scope

You can pipe scopes to Remove-BrokerScope.

Return Values

Examples

Example 1

C:\PS> Remove-BrokerScope Sales,Marketing -DesktopGroup "Win7 Desktops"

<!--NeedCopy-->

Description

Removes the “Win7 Desktops” desktop group from both the Sales and Marketing scopes.

Example 2

C:\PS> Sales,Marketing | Remove-BrokerScope -DesktopGroup 'Win7 Desktops'

<!--NeedCopy-->

Description

Removes the “Win7 Desktops” desktop group from both the Sales and Marketing scopes.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-BrokerScope

June 30, 2023

Contributed by:

June 30, 2023

Contributed by:

Remove-BrokerScope

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Scope

Return Values

Examples

Example 1

Description

Example 2

Description

In this article