Citrix Daas SDK

Move-BrokerDesktopGroup

August 9, 2024

Contributed by:

C C

Move a desktop group from one admin folder to another

Syntax

Move-BrokerDesktopGroup
    [-InputObject] <DesktopGroup[]>
    [-PassThru]
    [-Destination] <AdminFolder>
    [-NewName <String>]
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Move-BrokerDesktopGroup
    [-Name] <String>
    [-PassThru]
    [-Destination] <AdminFolder>
    [-NewName <String>]
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

The Move-BrokerDesktopGroup cmdlet moves a desktop group from one place to another in the tree of admin folders, optionally renaming it in the process (if you only want to change the name of the desktop group for administrative purposes and not its location in the tree, use the Rename-BrokerDesktopGroup cmdlet).

The location and name of a desktop group in this sense is only of interest to the administrator, changes do not affect the end-user experience.

Examples

Parameters

-InputObject

The desktop group(s) to be moved

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

-Name

The name of the desktop group to be moved

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

-Destination

The destination location within the admin folder hierarchy.

Type:	AdminFolder
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NewName

The new name of the desktop group in its new destination

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
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.DesktopGroup

You can pipe desktop groups to Move-BrokerDesktopGroup.

Outputs

None or Citrix.Broker.Admin.SDK.DesktopGroup

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.DesktopGroup object.

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

Move-BrokerDesktopGroup

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Move-BrokerDesktopGroup

Syntax

Description

Examples

Parameters

-InputObject

-Name

-Destination

-NewName

-PassThru

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.Broker.Admin.SDK.DesktopGroup

Outputs

None or Citrix.Broker.Admin.SDK.DesktopGroup

Related Links

In this article