Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Move-BrokerDesktopGroup

March 11, 2024
Contributed by: 
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.

Move-BrokerDesktopGroup
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.