Set-BrokerMachineCatalog
Moves one or more machines into a different catalog.
Syntax
Set-BrokerMachineCatalog
[-InputObject] <Machine[]>
[-CatalogUid] <Int32>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Set-BrokerMachineCatalog cmdlet is used to move machines into a different catalog. The following properties of the destination catalog must exactly match those of the machine's current catalog otherwise the command fails:
-
AllocationType
-
ProvisioningType
-
PersistUserChanges
-
SessionSupport
-
IsRemotePC
-
MinimumFunctionalLevel
-
PhysicalMachines
Changing a machine's catalog does not change the machine's desktop group membership. There is no effect on user sessions present on a machine if its catalog is changed.
Examples
EXAMPLE 1
This example finds all machines in domain Marketing and moves them into a catalog called MarketingMachines.
$catalog = Get-BrokerCatalog MarketingMachines
$machines = Get-BrokerMachine -MachineName 'Marketing\*'
Set-BrokerMachineCatalog $machines -CatalogUid $cat.Uid
Parameters
-InputObject
The machine instances that are being moved into a different catalog.
| Type: | Machine[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-CatalogUid
The unique identifier of the catalog into which the machines are being moved.
| Type: | Int32 |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| 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.Machine
You can pipe in the machines that are to be moved into a new catalog.
Outputs
None
By default, this cmdlet returns no output.