Product Documentation

Set-BrokerMachineCatalog

Nov 06, 2015

Moves one or more machines into a different catalog.

Syntax

Set-BrokerMachineCatalog [-InputObject] <Machine[]> [-CatalogUid] <Int32> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed 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:

o AllocationType

o ProvisioningType

o PersistUserChanges

o SessionSupport

o IsRemotePC

o MinimumFunctionalLevel

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

Parameters

-InputObject<Machine[]>

The machine instances that are being moved into a different catalog.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-CatalogUid<Int32>

The unique identifier of the catalog into which the machines are being moved.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.Machine You can pipe in the machines that are to be moved into a new catalog.

Return Values

None

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> $catalog = Get-BrokerCatalog MarketingMachines 
          C:\PS> $machines = Get-BrokerMachine -MachineName 'Marketing\*' 
          C:\PS> Set-BrokerMachineCatalog $machines -CatalogUid $cat.Uid

This example finds all machines in domain Marketing and moves them into a catalog called MarketingMachines.