Add-BrokerDesktopGroup
Associate Remote PC desktop groups with the specified Remote PC catalog.
Syntax
Add-BrokerDesktopGroup
[-InputObject] <DesktopGroup[]>
[-RemotePCCatalog <Catalog>]
[-Priority <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-BrokerDesktopGroup
[-Name] <String>
[-RemotePCCatalog <Catalog>]
[-Priority <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet forms relationships between Remote PC desktop groups and catalogs.
The Remote PC relationships are used by Remote PC automation to determine which desktop groups a machine in a particular Remote PC catalog can be published to. The assignment policy rules belonging to those desktop groups also determines the set of users that are allowed to be assigned to machines from the catalog.
Examples
EXAMPLE 1
Add all Remote PC desktop groups to Remote PC catalog 42.
Get-BrokerDesktopGroup -IsRemotePC $true | Add-BrokerDesktopGroup -RemotePCCatalog 42
EXAMPLE 2
Add desktop groups with names containing MyGroup to Remote PC catalog with name "RPCCat".
Add-BrokerDesktopGroup -Name *MyGroup* -RemotePCCatalog RPCCat
Parameters
-InputObject
Specifies one or more Remote PC desktop groups to add to a Remote PC catalog.
| Type: | DesktopGroup[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Specifies the Remote PC desktop groups to add to a Remote PC catalog based on their name properties.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-RemotePCCatalog
The Remote PC catalog which the desktop groups are to be added to. Specified by name, Uid or instance.
| Type: | Catalog |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Priority
Desktop group to catalog associations carry a priority number, where numerically lower values indicate a higher priority.
The priority relative to other associations determines which desktop group Remote PC automation will move a qualifying unconfigured machine into when it registers. Priority also determines which desktop group a machine will be published to when a user is assigned to the machine by Remote PC automation.
If a value is not supplied, then the desktop group association is automatically assigned a lower priority than any existing associations.
If a priority value is specified that conflicts with an existing association's priority value, then the new association is inserted with that value and existing associations are renumbered upwards to accommodate it.
| Type: | Int32 |
| Position: | Named |
| Default value: | See description |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| 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.DesktopGroup
The set of Remote PC desktop groups to be added to the catalog can be piped into this cmdlet.
Outputs
None
By default, this cmdlet returns no output.