Citrix Virtual Apps and Desktops SDK

Move-ProvVMDisk

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2305

Move the disks of full clone virtual machines to a new storage.

Syntax

Move-ProvVMDisk
    [-ProvisioningSchemeName] <String>
    -VMName <String[]>
    -DestinationStorageId <String[]>
    -DiskType <String[]>
    [-RunAsynchronously]
    [-PurgeJobOnSuccess]
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Move-ProvVMDisk
    [-ProvisioningSchemeUid] <Guid>
    -VMName <String[]>
    -DestinationStorageId <String[]>
    -DiskType <String[]>
    [-RunAsynchronously]
    [-PurgeJobOnSuccess]
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Allows you to move the disks of full clone virtual machines to a new storage and the new storage info will be updated to MCS database.

Examples

EXAMPLE 1

Move the disks of machine01 in provisioning scheme myProvScheme. Move OS and Identity disks to datastore1 and WBC disk to datastore2.

Move-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -VMName "machine01" -DiskType OS,Identity,WBC -DestinationStorageId datastore1,datastore1,datastore2
<!--NeedCopy-->

EXAMPLE 2

Move the disks of machine01 in provisioning scheme myProvScheme. Move OS and Identity disks to datastore1 and keep WBC disk storage unchanged.

Move-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -VMName "machine01" -DiskType OS,Identity,WBC -DestinationStorageId datastore1,datastore1,None
<!--NeedCopy-->

EXAMPLE 3

Move the disks of machine01 in provisioning scheme myProvScheme. Move WBC disk to datastore2 and keep OS and Identity disks storage unchanged.

Move-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -VMName "machine01" -DiskType OS,Identity,WBC -DestinationStorageId None,None,datastore2
<!--NeedCopy-->

EXAMPLE 4

Move the disks of machine01 and machine02 in provisioning scheme myProvScheme. The VMs don’t have WBC disk. Move OS and Identity disks to datastore1. The example applies to both CleanOnBoot and FullClone VMs.

Move-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -VMName ("machine01","machine02") -DiskType OS,Identity -DestinationStorageId datastore1,datastore1
<!--NeedCopy-->

EXAMPLE 5

Move all VMs’ disks in provisioning scheme myProvScheme. Move OS and Identity disks to datastore1 and WBC disk to datastore2

,(Get-ProvVM -ProvisioningSchemeName "myProvScheme") | Move-ProvVMDisk -ProvisioningSchemeName "myProvScheme" -DiskType OS,Identity,WBC -DestinationStorageId datastore1,datastore1,datastore2
<!--NeedCopy-->

Parameters

-VMName

List of VM names that will be have the disk moving.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName, ByValue)
Accept wildcard characters:	False

-DestinationStorageId

Indicates the destination storage Ids for OS/Identity/WBC disks. Each disk should provide corresponding destionation storage. If don’t want to move a disk, set its destination storage to string “None”. The storage details can refer to Get-ProvSchemeResourceInStorage

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

-DiskType

Indicates the types of disks. “OS”,”Identity” and “WBC”. All available types of citrix provisioned disks in the VM must be provided regardless of moving or not. For CleanOnBoot VM, only citrix provisioned disks can be selected to move. For full clone VM, only support to move all disks together including customer privately attached disks.

Type:	String[]
Accepted values:	OS, Identity, WBC
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProvisioningSchemeName

The name of the provisioning scheme from which VMs’ disks will be moved.

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

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme from which VMs’ disks will be moved.

Type:	Guid
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RunAsynchronously

Indicates whether an identifier for the task must returned before completion of the task. The progress of the task can be monitored using ‘get-ProvTask’ command.

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

-PurgeJobOnSuccess

Indicates that the task history is removed from the database when the task completes. This cannot be specified for tasks that run asynchronously.

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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.MachineCreation.Sdk.ProvisionedVirtualMachine

You can pipe an object containing parameters called ‘VMName’ and ‘ProvisioningSchemeName’ to move disks.

Outputs

Guid

When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier.

System.Management.Automation.PSCustomObject

This object provides details of the task that was run and contains the following information:

TaskId <Guid>

The identifier for the task that was performed.

Active <bool>

Indicates whether the task is still processing or is complete.

Host <string>

The name of the host on which the task is running or was run.

DateStarted <DateTime>

The date and time when the task was started.

Metadata <Citrix.MachineCreation.Sdk.Metadata[]>

The list of metadata stored for the task. For new tasks, this is empty until metadata is added.

CurrentOperation <string>

Operation specific phase of the overall “Running” task state.

TaskProgress <double>

The progress of the task 0-100%.

LastUpdateTime <DateTime>

The date and time of the last task status update.

ActiveElapsedTime <int>

Number of seconds the task has taken for active execution.

DateFinished <DateTime>

The date and time when the task was completed.

TerminatingError < Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError>

Diagnostic information if the task completely fails.

Type <Citrix.XDInterServiceTypes.JobType>

The type of task. For move vm disks task, this is always “Move-ProvVMDisk”.

Status <string>

Where in its lifecycle the task is.

DiskMovedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]>

See DiskMoveFailedVirtualMachines for details of the object parameters.

DiskMoveFailedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]>

ADAccountName <string>

The domain-qualified AD Account name of the machine.

ADAccountSid <string>

The AD account SID of the machine account.

DiagnosticInformation <Citrix.MachineCreation.Sdk.ExceptionSurrogate[]>

A collection of handled error states which caused the provisioning to fail.

ExceptionType <string>

The type of exception this object represents.

Message <string>

The exception message.

Details <string>

The full exception content including stack trace.

InnerException <Citrix.MachineCreation.Sdk.ExceptionSurrogate>

Information relating to any contributing error state.

Status <string>

The status of the virtual machine.

StatusAdditionalInformation <string>

Extra information about the Status.

VMId <string>

The virtual machine identifier in the hypervisor.

VMName <string>

The display name of the virtual machine in the hypervisor.

NotStartedVirtualMachines <Citrix.DesktopUpdateManager.SDK.VirtualMachineCreation[]>

See FailedVirtualMachines for details of the object parameters.

ProvisioningSchemeName <string>

The name of the provisioning scheme from which the VM was created.

ProvisioningSchemeUid <Guid>

The unique identifier of the provisioning scheme from which the VM was created.

TaskState <Citrix.DesktopUpdateManager.SDK.ProvisionVMState>

The state of the task. This can be any of the following:

Processing

Indicates that the task is in its initial state.

LocatingResources,

Indicates that the task is locating information from other services.

HostingUnitNotFound

Indicates that the required hosting unit could not be located.

ProvisioningSchemeNotFound

Indicates that the required provisioning scheme could not be located.

Provisioning

Indicates that the task is at the provisioning stage.

IdentityPoolNotFound

Indicates that the required identity pool could not be located.

TaskAlreadyRunningForProvisioningScheme

Indicates that the provisioning scheme already has another task running.

Finalizing

Indicates that the task is finalizing.

Finished

Indicates that the task is complete.

FinishedWithErrors

Indicates that the task is complete but there were errors. Specific details of errors are included with each failed virtual machine.

Removing

Indicates that the task is removing virtual machines from the hypervisor.

Failed

Job failed for reasons specified in TaskStateInformation.

Canceled

Indicates that the task was stopped by user intervention (using Stop-ProvTask)

TaskStateInformation <string>

Provides more detailed information about the current task state.

WorkflowStatus <System.Workflow.Runtime.WorkflowStatus>

Indicates the status of the workflow that is used to process the task.

TaskExpectedCompletion <DateTime>

The date and time at which the task is expected to complete.

Notes

The cmdlet is associated with a task of type MoveVMDiskTask, and while active will move through the following operations (CurrentOperation field):

ValidatingInputs

MoveVMDisks

ReplicateBaseDisks

RemoveStaleBaseDsik

Only one long-running task for each provisioning scheme can be processed at a time.

In the case of failure, the following errors can result.

Error Codes

ProvisioningSchemeNotFound

The specified provisioning scheme could not be located.

ProvisioningSchemeNotReady

The specified provisioning scheme is not in Ready state.

JobCreationFailed

The requested task could not be started.

DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

ServiceStatusInvalidDb

An error occurred in the service while attempting a database operation. Communication with the database failed for

for various reasons.

WorkflowHostUnavailable

The task could not be started because the database connection is inactive.

CommunicationError

An error occurred while communicating with the service.

InvalidParameterCombination

Both PurgeJobOnSuccess and RunAsynchronously were specified. When running asynchronously, the cmdlet terminates before the job does, so it cannot clean up the completed job.

PermissionDenied

The user does not have administrative rights to perform this operation.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.

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-ProvVMDisk

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Move-ProvVMDisk

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

EXAMPLE 5

Parameters

-VMName

-DestinationStorageId

-DiskType

-ProvisioningSchemeName

-ProvisioningSchemeUid

-RunAsynchronously

-PurgeJobOnSuccess

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ProvisionedVirtualMachine

Outputs

Guid

System.Management.Automation.PSCustomObject

Notes

Related Links

In this article