Citrix Daas SDK

Add-BrokerMachine

August 9, 2024

Contributed by:

C C

Adds one or more machines to a desktop group.

Syntax

Add-BrokerMachine
   [-InputObject] <Machine[]>
   [-DesktopGroup <DesktopGroup>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Add-BrokerMachine
   [-MachineName] <String>
   [-DesktopGroup <DesktopGroup>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Add-BrokerMachine cmdlet adds specified machines to a desktop group. There are three forms:

Use the -InputObject parameter to add a single machine instance or array of

instances to the group.
Use the -MachineName parameter to add a single, named machine to the

group.
Use pipelining to pipe machines instances to the command.

The desktop group to which the machines are added can be specified by name, unique identifier (UID), or instance.

For a machine to be used in a site, the machine must be added to a desktop group. The machine and desktop group must be compatible in order for the process to succeed; for example a machine in a single-session catalog cannot be added to a multi-session desktop group.

For more information about machines, see about_Broker_Machines.

Examples

EXAMPLE 1

These examples all add a single machine instance to a desktop group, identifying the group by instance, UID, or name.

Add-BrokerMachine -InputObject $machine -DesktopGroup $desktopGroup
Add-BrokerMachine -InputObject $machine -DesktopGroup 2
Add-BrokerMachine $machine -DesktopGroup "MyDesktopGroup"
<!--NeedCopy-->

EXAMPLE 2

These examples add the machine called MyMachine to a desktop group.

Add-BrokerMachine -MachineName "MyDomain\MyMachine" -DesktopGroup 2
Add-BrokerMachine "MyDomain\MyMachine" -DesktopGroup "MyDesktopGroup"
Add-BrokerMachine "MyDomain\MyMachine" -DesktopGroup $desktopGroup
<!--NeedCopy-->

EXAMPLE 3

These examples find specific machines and add them to a desktop group.

Get-BrokerMachine -Uid 3 | Add-BrokerMachine -DesktopGroup 2
Get-BrokerMachine -CatalogUid 4 | Add-BrokerMachine -DesktopGroup 2
<!--NeedCopy-->

Parameters

-InputObject

An array of machines to add to the group.

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

-MachineName

The name of the single machine to add (must match the MachineName property of the machine).

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

-DesktopGroup

The desktop group to which the machines 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.Machine

You can pipe in the machines you want to add.

Outputs

None

By default, this cmdlet returns no output.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Add-BrokerMachine

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Add-BrokerMachine

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

Parameters

-InputObject

-MachineName

-DesktopGroup

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.Machine

Outputs

None

Related Links

In this article