Citrix Virtual Apps and Desktops SDK

Move-BrokerApplication

Move a published application from one admin folder to another

Syntax

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

Description

The Move-BrokerApplication cmdlet moves a published application 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 application for administrative purposes and not its location in the tree, use the Rename-BrokerApplication cmdlet).

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

Examples

EXAMPLE 1

Moves the application in the root folder called “App1” to the folder “F1".

Move-BrokerApplication -Name 'App1' -Destination 'F1\'
<!--NeedCopy-->

EXAMPLE 2

Moves the application in folder “F1” called “App1” to the folder “F2", renaming it to “Application1” in the process.

Move-BrokerApplication 'F1\App1' 'F2\' -NewName 'Application1'
<!--NeedCopy-->

Parameters

-InputObject

The application(s) to be moved

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

-Name

The application(s) 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 application 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.Application

You can pipe applications to Move-BrokerApplication.

Outputs

None or Citrix.Broker.Admin.SDK.Application

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

Move-BrokerApplication