Citrix Virtual Apps and Desktops SDK

Add-BrokerMachineConfiguration

Adds a machine configuration to a desktop group.

Syntax

Add-BrokerMachineConfiguration
   [-InputObject] <MachineConfiguration[]>
   [-Application <Application>]
   [-DesktopGroup <DesktopGroup>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Add-BrokerMachineConfiguration
   [-Name] <String>
   [-Application <Application>]
   [-DesktopGroup <DesktopGroup>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Add-BrokerMachineConfiguration -Name UPM\Conf1 -DesktopGroup 1
<!--NeedCopy-->

EXAMPLE 2

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

$mc | Add-BrokerMachineConfiguration -DesktopGroup AdminDesktops
<!--NeedCopy-->

Parameters

-InputObject

Machine configuration to add to the desktop group.

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

-Name

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

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-Application

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

Type: Application
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DesktopGroup

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

Type: DesktopGroup
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.MachineConfiguration

The machine configuration to add to the desktop group.

Outputs

None

By default, this cmdlet returns no output.

Add-BrokerMachineConfiguration