Citrix Daas SDK

Add-BrokerScope

Add the specified catalog/desktop group to the given scope(s).

Syntax

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

Description

The Add-BrokerScope cmdlet is used to associate a scopeable object with the given scope(s). A scopeable object is one of:

  • a catalog
  • a desktop group
  • an application group

To add a scopeable object to a scope you need permission to change the scopes of the scopeable object and permission to add objects to all of the scopes you have specified.

If the scopeable object is already in any scope supplied, that scope will be silently ignored.

Examples

EXAMPLE 1

Adds the desktop group with Uid 27 to the Sales scope.

Add-BrokerScope Sales -DesktopGroup 27
<!--NeedCopy-->

EXAMPLE 2

Adds the BangaloreMachines catalog to the scope with the specified ScopeID.

Add-BrokerScope BFC74867-C6EF-482C-996F-3E0D340E96AC -Catalog BangaloreMachines
<!--NeedCopy-->

Parameters

-InputObject

Specifies the scope(s) to add the object to. Each can take the form of either the string form of the scope’s GUID or its name.

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

-ApplicationGroup

Specifies the application group to be added. This can take the form of an existing application group object, an application group Uid or name.

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 added. This can take the form of an existing catalog object, a catalog Uid or name.

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 added. This can take the form of an existing desktop group object, a desktop group Uid or name.

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 added. This can take the form of an existing policy set object, a policy set Uid or name.

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 added. This can take the form of an existing tag object, a tag Uid or name.

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

Outputs

None

By default, this cmdlet returns no output.

Add-BrokerScope