Citrix Virtual Apps and Desktops SDK

Remove-BrokerScope

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

Syntax

Remove-BrokerScope
      [-InputObject] <Scope[]>
      [-ApplicationGroup <ApplicationGroup>]
      [-Catalog <Catalog>]
      [-DesktopGroup <DesktopGroup>]
      [-PolicySet <GpoPolicySet>]
      [-Tag <Tag>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Remove-BrokerScope Sales,Marketing -DesktopGroup "Win7 Desktops"
<!--NeedCopy-->

EXAMPLE 2

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

Sales,Marketing | Remove-BrokerScope -DesktopGroup 'Win7 Desktops'
<!--NeedCopy-->

Parameters

-InputObject

Specifies the scopes to remove the object from.

Type: Scope[]
Position: 2
Default value: Null
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ApplicationGroup

Specifies the application group object to be removed.

Type: ApplicationGroup
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Catalog

Specifies the catalog object to be removed.

Type: Catalog
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DesktopGroup

Specifies the desktop group object to be removed.

Type: DesktopGroup
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PolicySet

Specifies the policy set object to be removed.

Type: GpoPolicySet
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Tag

Specifies the tag object to be removed.

Type: Tag
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

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

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Citrix.Broker.Admin.SDK.Scope

You can pipe scopes to Remove-BrokerScope.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerScope