Citrix Virtual Apps and Desktops SDK

Set-ProvSchemeImage

April 19, 2024

Contributed by:

Update the master image associated with the provisioning scheme.

Syntax

Set-ProvSchemeImage
   [-ProvisioningSchemeName] <String>
   -ImageVersionSpecUid <Guid>
   [-DoNotStoreOldImage]
   [-RunAsynchronously]
   [-PurgeJobOnSuccess]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Set-ProvSchemeImage
   -ProvisioningSchemeUid <Guid>
   -ImageVersionSpecUid <Guid>
   [-DoNotStoreOldImage]
   [-RunAsynchronously]
   [-PurgeJobOnSuccess]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to update the hard disk image used to provision virtual machines. If the provisioning scheme is a ‘CleanOnBoot’ type, then the next time that virtual machines are started, their hard disks are updated to this new image. Regardless of the ‘CleanOnBoot’ type, all new virtual machines created after this command will use this new hard disk image.

A background task will be created to remove the old hard disk copies. You can locate and monitor this task using the Get-ProvTask cmdlet.

A snapshot or VM template is used rather than a VM, so that the content of the hard disk for the provisioning scheme can be easily determined.

As the snapshot or VM template are specified using a path into the Citrix Host Service PowerShell Provider, the Citrix Host Service PowerShell snap-in must also be loaded for this cmdlet to be used.

The previous hard disk image path is stored into the history (see Get-ProvSchemeMasterVMImageHistory). The data stored in the history allows for a rollback to be undertaken, to revert to the previous hard disk image if required.

Examples

EXAMPLE 1

Updates the image version spec for the provisioning Scheme “MyScheme” to use the image versipn spec 5991ba52-cad1-4e9c-b34f-1a6156e5f140.

Set-ProvSchemeImage -ProvisioningSchemeName MyScheme -ImageVersionSpecUid 5991ba52-cad1-4e9c-b34f-1a6156e5f140

TaskId                 : 248f102f-073f-45fe-aea9-1819a6d6dd1f
Active                 : False
Host                   : MyHost
DateStarted            : 17/05/2010 17:37:57
Type                   : SetProvisioningSchemeImage
Status                 :
CurrentOperation       :
TaskExpectedCompletion : 17/05/2010 17:38:43
LastUpdateTime         : 17/05/2010 17:38:43
ActiveElapsedTime      : 46
DateFinished           : 17/05/2010 17:38:43
TerminatingError       :
WorkflowStatus         : Completed
ProvisioningSchemeUid  : 7585f0de-192e-4847-a6d8-22713c3a2f42
ProvisioningSchemeName : MyScheme
ImageVersionNumber     : 2
ImageVersionUid        : 5991ba52-cad1-4e9c-b34f-1a6156e5f140
ImageDefinitionName    : myImage
ImageDefinitionUid     : 42bd09f5-3fac-44a6-8b1c-7c09f1079cc0
MasterImage            : /RhoneCC_baseXP.vm/base.snapshot
HostingUnitName        : HostUnit1
HostingUnitUid         : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
TaskState              : Finished
TaskStateInformation   : Completed
TaskProgress           : 100
Warnings               : {}
DiskSize               : 32
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The provisioning scheme to which the hard disk image should be updated.

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

-ProvisioningSchemeUid

The provisioning uid identifier to which the hard disk image should be updated.

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

-ImageVersionSpecUid

The identifier for the image versipn spec uid used for the provisioning scheme.

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

-RunAsynchronously

Indicates whether or not the cmdlet should return before it is complete. If specified, the command returns an identifier for the task that was created. You can monitor this task using the Get-ProvTask cmdlet.

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

-PurgeJobOnSuccess

Indicates that the task history will be removed from the database once the task has finished. This cannot be specified for tasks that are run asynchronously.

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

-DoNotStoreOldImage

Indicates that the current image should not be added to the image history list for the provisioning scheme. This is useful when rolling back to a previous image.

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

None

You can’t pipe objects to this cmdlet.

Outputs

Guid

When “RunAsynchronously” is specified, this identifier is returned to provide the task identifier.

System.Management.Automation.PSCustomObject

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

TaskId <Guid>

The identifier for the task that was performed.

Active <Boolean>

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 that the task was initiated.

Type <Citrix.XDInterServiceTypes.JobType>

The type of the task. For set provisioning scheme image tasks this is always “SetProvisioningSchemeImage”.

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

The list of metadata stored against the task. For new tasks this will be empty until metadata is added.

WorkflowStatus <System.Workflow.Runtime.WorkflowStatus>

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

ProvisioningSchemeName <string>

The name of the provisioning scheme that the task was for.

ProvisioningSchemeUid <Guid>

The unique identifier of the provisioning scheme that the task was for.

MasterImage <string>

The path (in the hosting unit provider) of the virtual machine snapshot or VM template that was used as the master image for the task.

IdentityPoolName <string>

The name of the identity pool (from the ADIdentity PowerShell snap-in) that the new provisioning scheme will use.

IdentityPoolUid <guid>

The unique identifier name of the identity pool (from the ADIdentity PowerShell snap-in) that the new provisioning scheme will use.

HostingUnitName <string>

The name of the hosting unit (from the Hosting Unit PowerShell snap-in) that the new provisioning scheme will use.

HostingUnitUid

The unique identifier of the hosting unit (from the Hosting Unit PowerShell snap-in) that the new provisioning scheme will use.

MasterImageNote

The note of the provisioning scheme image.

TaskState <Citrix.DesktopUpdateManager.SDK.NewProvisioningSchemeState>

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

Processing

Indicates that the task has just begun and has not done anything yet.

LocatingResources,

Indicates that the workflow is locating resources from other services.

HostingUnitNotFound

Indicates that the task failed because the required hosting unit could not be located.

VirtualMachineSnapshotNotFound

Indicates that the task failed because the required snapshot or VM template could not be located.

ConsolidatingMasterImage

Indicates that the task is consolidating the master image.

ReplicatingConsolidatedImageToAllStorage

Indicates that the task is replicating the consolidated master image.

StoringProvisioningScheme

Indicates that the task is storing the provisioning scheme data to the database.

Finished

Indicates that the task has completed with no errors.

ProvisioningSchemeAlreadyExists

Indicates that the task failed because a provisioning scheme with the same name already exists.

IdentityPoolNotFound

Indicates that the task failed because the identity pool specified could not be found.

MasterVMImageIsNotPartOfProvisioningSchemeHostingUnit,

Indicates that the hosting unit that the master image originated from is not the same hosting unit that the provisioning scheme is defined to use.

MasterVmImageIsNotASnapshot

Indicates that the task failed because the master VM image path does not refer to a snapshot or a VM template item.

ProvisioningSchemeNotFound

Could not find a provisioning scheme with the specified name.

TaskAlreadyRunningForProvisioningScheme

A task for a provisioning scheme with the same name is already running.

InvalidMasterVMConfiguration

The VM snapshot or VM template specified as the master had an invalid configuration.

InvalidMasterVMState

The VM snapshot or VM template specified as the master is currently in an invalid state.

InsufficientResources

Indicates that the task failed because the hypervisor did not have enough resources to complete the task.

StorageNotFound

Indicates that no associated storage was found in the hosting unit.

Canceled

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

TaskStateInformation <string>

Holds string data providing more details about the current task state.

TaskProgress

The progress of the task 0-100%.

Notes

Only one long-running task per provisioning scheme can be processed at any one 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.

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. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

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

ValidatingInputs

ReplicatingMasterImage

CommittingScheme

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

Set-ProvSchemeImage

April 19, 2024

Contributed by:

April 19, 2024

Contributed by:

Set-ProvSchemeImage

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ProvisioningSchemeName

-ProvisioningSchemeUid

-ImageVersionSpecUid

-RunAsynchronously

-PurgeJobOnSuccess

-DoNotStoreOldImage

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Guid

System.Management.Automation.PSCustomObject

Notes

Related Links

In this article