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

New-ProvMasterVMImage

August 3, 2023
Contributed by: 
C

Prepare a new master image for a provisioning scheme.

Syntax


New-ProvMasterVMImage [-ProvisioningSchemeName] <String> -MasterImageVM <String> [-VhdTemplateSource <String>] [-VhdResultDestination <String>] [-AppScanResultsFile <String>] [-FunctionalLevel <String>] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

New-ProvMasterVMImage -ProvisioningSchemeUid <Guid> -MasterImageVM <String> [-VhdTemplateSource <String>] [-VhdResultDestination <String>] [-AppScanResultsFile <String>] [-FunctionalLevel <String>] [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to prepare an update for the hard disk image used to create VMs.

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

As the snapshot is specified using a path into the Citrix Host Service Powershell Provider, the Citrix Host Service Powershell snap-in must also be loaded to use this cmdlet.

The prepared hard disk image path is stored into the history (see Get-ProvSchemeMasterVMImageHistory). The data stored in the history allows to do a fast update using the newly prepared hard disk image at a time chosen by the system administrator.

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The provisioning scheme to which the hard disk image should be updated. true true (ByPropertyName)  
MasterImageVM The path in the hosting unit provider to the VM snapshot or template that will be used. This identifies the hard disk to be used and the default values for the memory and processors. This must be a path to a Snapshot or Template item in the same hosting unit used by the provisioning scheme specified by ProvisioningSchemeName or ProvisioningSchemeUid. Valid paths are of the format      
XDHyp:\HostingUnits<HostingUnitName><path><VMName>.vm<SnapshotName>.snapshot XDHyp:\HostingUnits<HostingUnitName><path><TemplateName>.template true true (ByPropertyName)    
ProvisioningSchemeUid The provisioning scheme identifier to which the hard disk image should be updated. true false  
VhdTemplateSource File path to a source VHD template to be used when performing application scanning during image preparation. The presence of this parameter in conjunction with VhdResultDestination implies that application scanning is to be performed false false  
VhdResultDestination File path (including file name) where the VHD disk file containing the results of application scanning should be written. false false  
AppScanResultsFile File name to which the results of application scanning should be written. false false  
FunctionalLevel The FunctionalLevel of the VDA installed on the given MasterImageVM. false false  
RunAsynchronously Indicates whether 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. false false false
PurgeJobOnSuccess Indicates that the task history will be removed from the database when the task completes. This cannot be specified for tasks that run asynchronously. false false 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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Machinecreation.Sdk.Provisioningscheme

You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ to New-ProvMasterVMImage.

Return Values

System.Guid

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

Notes

The cmdlet is associated with a task of type PublishImage, and while active will move through the following operations (CurrentOperation field) ValidatingInputs ConsolidatingMasterImage PreparingMasterImage ReplicatingMasterImage 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.

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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.
UnsupportedByServer The requested operation is not supported by this version of the service.

Examples

Example 1 


c:\PS>New-ProvMasterVMImage -ProvisioningSchemeName MyScheme -MasterImageVM XDHyp:\H

          stingUnits\HostUnit1\RhoneCC_baseXP.vm\base.snapshot

          TaskId                 : 248f102f-073f-45fe-aea9-1819a6d6dd1f

          Type                   : PublishImage

          DateStarted            : 17/05/2020 17:37:57

          Status                 :

          CurrentOperation       :

          TaskExpectedCompletion :

          LastUpdateTime         : 17/05/2020 08:24:08

          ActiveElapsedTime      : 11

          DateStarted            : 17/05/2020 08:22:22

          DateFinished           : 17/05/2020 08:24:08

          TerminatingError       :

          WorkflowStatus         : Completed

          ProvisioningSchemeUid  : 7585f0de-192e-4847-a6d8-22713c3a2f42

          ProvisioningSchemeName : MyScheme

          MasterImage            : /RhoneCC_baseXP.vm/base.snapshot

          HostingUnitName        : HostUnit1

          MasterImageNote        :

          HostingUnitUid         : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

          TaskState              : Finished

          TaskStateInformation   :

          TaskProgress           : 100

          Warnings               : {0}

          DiskSize               : 24

<!--NeedCopy-->

Description

Prepares a new master hard disk image for the provisioning Scheme “MyScheme” using the “base.snapshot” hard disk image.

New-ProvMasterVMImage
August 3, 2023
Contributed by: 
C
August 3, 2023
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.