Product Documentation

Add-BrokerMachineConfiguration

Oct 12, 2015

Adds a machine configuration to a desktop group.

Syntax

Add-BrokerMachineConfiguration [-InputObject] <MachineConfiguration[]> [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Add-BrokerMachineConfiguration [-Name] <String> [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Associates a machine configuration with a desktop group. The settings in the machine configuration are then applied to the machines in the desktop group.

Parameters

-InputObject<MachineConfiguration[]>

Machine configuration to add to the desktop group.

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

-Name<String>

Name of a machine configuration to add to the desktop group.

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

-DesktopGroup<DesktopGroup>

The desktop group to which the machine configurations are added, specified by name, Uid, or instance.

Required? false
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.MachineConfiguration The machine configuration to add to the desktop group.

Return Values

None

Examples

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

Add-BrokerMachineConfiguration -Name UPM\Conf1 -DesktopGroup 1

Adds the machine configuration named UPM\Conf1 to the desktop group with Uid 1.

-------------------------- EXAMPLE 2 --------------------------

$mc | Add-BrokerMachineConfiguration -DesktopGroup AdminDesktops

Adds the machine configuration $mc to the desktop group named "AdminDesktops".