Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2303 2212 2209 2206 2203 2112 2109 2103 1912

New-ProvScheme

August 3, 2023
Contributed by: 
C

Creates a new provisioning scheme.

Syntax


New-ProvScheme [-ProvisioningSchemeName] <String> -HostingUnitName <String> -IdentityPoolName <String> -MasterImageVM <String> [-VMCpuCount <Int32>] [-VMMemoryMB <Int32>] [-CleanOnBoot] [-UsePersonalVDiskStorage] [-UseWriteBackCache] [-Scope <String[]>] [-NoImagePreparation] [-NetworkMapping <Hashtable>] [-Metadata <Hashtable>] [-ServiceOffering <String>] [-SecurityGroup <String[]>] [-DedicatedTenancy] [-TenancyType <String>] [-VhdTemplateSource <String>] [-VhdResultDestination <String>] [-AppScanResultsFile <String>] [-MachineProfile <String>] [-CustomProperties <String>] [-ResetAdministratorPasswords] [-FunctionalLevel <String>] [-UseFullDiskCloneProvisioning] [-MasterImageNote <String>] [-RunAsynchronously] [-PurgeJobOnSuccess] [-InitialBatchSizeHint <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

New-ProvScheme [-ProvisioningSchemeName] <String> -HostingUnitUid <Guid> -IdentityPoolUid <Guid> -MasterImageVM <String> [-VMCpuCount <Int32>] [-VMMemoryMB <Int32>] [-CleanOnBoot] [-UsePersonalVDiskStorage] [-UseWriteBackCache] [-Scope <String[]>] [-NoImagePreparation] [-NetworkMapping <Hashtable>] [-Metadata <Hashtable>] [-ServiceOffering <String>] [-SecurityGroup <String[]>] [-DedicatedTenancy] [-TenancyType <String>] [-VhdTemplateSource <String>] [-VhdResultDestination <String>] [-AppScanResultsFile <String>] [-MachineProfile <String>] [-CustomProperties <String>] [-ResetAdministratorPasswords] [-FunctionalLevel <String>] [-UseFullDiskCloneProvisioning] [-MasterImageNote <String>] [-RunAsynchronously] [-PurgeJobOnSuccess] [-InitialBatchSizeHint <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Allows you to create a new provisioning scheme. The creation process makes a copy of the hard disk attached to a virtual machine snapshot or VM template and stores it in every storage location that the hosting unit referenced by the provisioning scheme defines. This is a long-running task and typically takes several minutes to complete (depending on the size of the hard disk that is being copied and the number of snapshots that the hard disk consists of).

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

Because 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 to use this cmdlet.

This cmdlet requires information to be provided that is retrieved using other snap-ins that form part of the Citrix Machine Creation Services: Hosting Unit Service Snapin The snap-in that provides information about the hypervisors. AD Identity Service Snapin The snap-in that provides information about the identity pools.

The provisioning scheme is a collection of all of the data that is required to form a template against which virtual machines can be created. It therefore requires the following: Hosting Unit A reference to an item defined in the Host Service that defines the hypervisor, the network, and the storage to be used. Identity Pool A reference to the collection of Active Directory accounts that is used for VMs created from the provisioning scheme.

Parameters

Name Description Required? Pipeline Input Default Value  
ProvisioningSchemeName The name of the provisioning scheme to be created. This must not be a name that is being used by an existing provisioning scheme, and must not contain any of the following characters \/;:#.*?=<> ”“’ true false  
HostingUnitName The name of the hosting unit to be used for the provisioning scheme. true false    
IdentityPoolName The name of the identity pool to be used for the provisioning scheme. true false    
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 specified by HostingUnitName or HostingUnitUid. Valid paths are of the format        
XDHyp:\HostingUnits<HostingUnitName><path><VMName>.vm<SnapshotName>.snapshot XDHyp:\HostingUnits<HostingUnitName><path><TemplateName>.template true true (ByPropertyName)      
HostingUnitUid The unique identifier of the hosting unit to be used for the provisioning scheme. true false    
IdentityPoolUid The unique identifier of the identity pool to be used for the provisioning scheme. true false    
VMCpuCount The number of processors that will be used to create VMs from the provisioning scheme. false false The number of CPUs assigned to the base image VM snapshot or VM template.  
VMMemoryMB The maximum amount of memory that will be used to created VMs from the provisioning scheme in MB. false false The amount of memory assigned to the base image VM snapshot or VM template.  
CleanOnBoot Indicates whether the VMs created from this provisioning scheme are reset to their initial condition each time they are started. false false false  
UsePersonalVDiskStorage Indicates whether personal vDisks are used for the VMs created from this provisioning scheme. false false    
UseWriteBackCache Indicates whether write-back cache is enabled for the VMs created from this provisioning scheme. Use additional parameters to configure the write-back cache. WriteBackCacheDiskSize: The size in GB of any temporary storage disk used by the write-back cache. Should be used in conjunction with WriteBackCacheMemorySize. WriteBackCacheMemorySize: The size in MB of any write-back cache if required. Should be used in conjunction with WriteBackCacheDiskSize. Setting RAM Cache to 0 but specifying Disk Cache effectively disables the RAM Cache. However, there will be some memory still used to allow the I/O Optimization to operate. false false    
Scope The administration scopes to be applied to the new provisioning scheme. false false    
NoImagePreparation Indicates that image preparation should not be performed on this provisioning scheme. false false    
NetworkMapping Specifies how the attached NICs are mapped to networks. If this parameter is omitted, VMs are created with a single NIC, which is mapped to the default network in the hosting unit. If this parameter is supplied, machines are created with the number of NICs specified in the map, and each NIC is attached to the specified network. false false    
Metadata The metadata to be associated with this provisioning scheme. false false    
ServiceOffering The Service Offering to use when creating VMs in Cloud Hypervisors. false false    
SecurityGroup The security groups to apply to VMs created in Cloud Hypervisors. false false    
DedicatedTenancy Indicates whether to use dedicated tenancy when creating VMs in Cloud Hypervisors. false false false  
TenancyType Indicates whether to use tenancy type Shared, Instance or Host when creating VMs in Cloud Hypervisors. false false Shared  
VhdTemplateSource A 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 A 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    
MachineProfile Currently only supported with Azure. Defines the inventory path to the source VM used by the provisioning scheme as a template. This profile identifies the properties for the VMs created from the scheme. The VM must be in the hosting unit that HostingUnitName or HostingUnitUid refers to. If any properties are present in the MachineProfile but not the CustomProperties, values from the template will be written back to the CustomProperties.        
Valid paths are of the format: XDHyp:\HostingUnits<HostingUnitName><path><VMName>.vm false false      
CustomProperties The properties of the provisioning scheme that are specific to the target hosting infrastructure. See about_ProvCustomProperties for more information. false false    
ResetAdministratorPasswords Indicates whether the passwords for administrator accounts are reset on created machines. false false    
FunctionalLevel The FunctionalLevel of the VDA installed on the given MasterImageVM. false false    
UseFullDiskCloneProvisioning Indicates whether VMs should be created using the dedicated full disk clone feature. false false    
MasterImageNote A note for the master image. false false    
RunAsynchronously Indicates whether the command returns before it completes. If specified, the command returns an identifier for the task that was created. This task can be monitored using the get-ProvTask command. false false false  
PurgeJobOnSuccess Indicates that the task history is removed from the database when the task completes. This can not be specified for tasks that run asynchronously. false false    
InitialBatchSizeHint Provides a predictive hint for the number of initial VMs that will be added to the MCS catalog when the scheme is succesfully created. Callers should supply this parameter in situations where the completion of New-ProvScheme will be closely followed by a New-ProvVM call to create an initial batch of VMs in the catalog. 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

Return Values

System.Guid

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

Notes

Only one long-running task for each provisioning scheme can be processed at a time. In 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.

  • MachineCreationServiceDoesNotSupportPersonalDisk: The service instance being used has not been upgraded to support the personal vDisk feature.

  • DatabaseMissingCapabilites: The database supporting the service instance being used has not been upgraded to support the personal vDisk feature.

  • 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.

  • ScopeNotFound: One or more of the scopes nominated for the new provisioning scheme do not exist.

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

  • 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.

  • VhdParametersMustBeSupplied: When parameter VhdTemplateSource or VhdResultDestination is supplied, both parameters are required to be supplied.

  • ServiceDoesNotSupportFullDiskClone: The full disk clone parameter is being used when the service does not support the full disk clone feature.

  • Upgrade: the service or remove the parameter.

  • FullDiskCloneDoesNotSupportCleanOnBootVMs: The full disk clone functionality is applicable to dedicated provisioned machines only.

  • FullDiskCloneDoesNotSupportPvdVMs: The full disk clone functionality is only applicable to dedicated provisioned machines that do not use Personal VDisks.

  • CannotUseWriteBackCacheWithCleanOnBootDisabled: Cannot turn on writebackcache on persistent catalog.

Do not use -UseWriteBackCache without specifying -CleanOnBoot.

The cmdlet is associated with a task of type NewProvisioningScheme, and while active will move through the following operations (CurrentOperation field) ValidatingInputs ConsolidatingMasterImage PreparingMasterImage ReplicatingMasterImage CommittingScheme

Examples

Example 1 


C:\PS> New-ProvScheme -ProvisioningSchemeName XenPS -HostingUnitName XenHu -IdentityPoolName idPool1 -CleanOnBoot -MasterImageVM XDHyp:\HostingUnits\XenHU\Base.vm\Base.snapshot

TaskId                              : 90e93b9d-a225-4701-ad50-fa1546af35ac

Type                                : NewProvisioningScheme

Status                              : Finished

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                    :

Storage                             : {}

WorkflowStatus                      : Completed

Warnings                            : {}

ProvisioningSchemeName              : XenPS

MasterImage                         : XDHyp:\HostingUnits\XenHU\Base.vm\Base.snapshot

IdentityPoolName                    : idPool1

IdentityPoolUid                     : 03743136-e43b-4a87-af74-ab71686b3c16

HostingUnitName                     : XenHU

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

CustomProperties                    :

InitialBatchSizeHint                : 0

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

TaskState                           : Finished

TaskStateInformation                :

TaskProgress                        : 100

DiskSize                            : 24

MasterImageNote                     :

PersonalVDiskDriveLetter            :

PersonalVDiskDriveSize              : 0

WriteBackCacheDiskSize              : 127

WriteBackCacheMemorySize            : 256

Scopes                              : {}

NetworkMaps                         : {0}

ProvisioningSchemeMetadata          : {}

ServiceOffering                     :

SecurityGroups                      :

DedicatedTenancy                    : False

ResetAdministratorPasswords         : True

StatusMessageSubstitutions          :

GpuTypeId                           :

UseFullDiskCloneProvisioning        : False

<!--NeedCopy-->

Description

Creates a new provisioning scheme with the name “XenPS” using the hosting unit “XenHu” and the identity pool “idPool1” from the master VM snapshot called “Base.snapshot”.

Example 2 


C:\PS> New-ProvScheme -ProvisioningSchemeName XenPS -HostingUnitName XenHu -IdentityPoolName idPool1 -CleanOnBoot -MasterImageVM XDHyp:\HostingUnits\XenHU\Base.vm\Base.snapshot -RunAsynchronously

Guid

----

6dd85fec-96cf-46b1-9cd4-d8ba7d06e85b

<!--NeedCopy-->

Description

Creates a new provisioning scheme with the name “XenPS” using the hosting unit “XenHu” and the identity pool “idPool1” from the master VM snapshot called “Base.snapshot” asynchronously. To get the task details, use Get-ProvTask -TaskID <task id>. i.e.

Example 3 


C:\PS>$provScheme = New-ProvScheme -ProvisioningSchemeName XenPS2 -HostingUnitName XenHu -IdentityPoolName idPool1 -CleanOnBoot -MasterImageVM XDHyp:\HostingUnits\XenHU\Base.vm\Base.snapshot -UsePersonalVDiskStorage -PersonalVDiskDriveSize 17 -PersonalVDiskDriveLetter x

<!--NeedCopy-->

Description

Creates a new provisioning scheme with the name “XenPS2” using the hosting unit “XenHu” and the identity pool “idPool1” from the master VM snapshot called “Base.snapshot”; apply a 17GB personal vDisk. The personal vDisk is mapped as drive X. The operation runs synchronously, and the return value contains the task details.

New-ProvScheme
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

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