Citrix Virtual Apps and Desktops SDK

Import-Provscheme

August 3, 2023

Contributed by:

Import a provisioning scheme into the site

Syntax

Import-ProvScheme [-ProvisioningSchemeData <String>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

This cmdlet imports a provisioning scheme into the site, the data passed to this cmdlet should be obtained via the Export-ProvScheme cmdlet generally obtained form a different site

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeData	Json encoded string of a provisioning scheme	false	true (ByPropertyName)
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
AdminAddress	Specifies the address of a XenDesktop 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

Citrix.Machinecreation.Sdk.Provisioningscheme
This Object Provides Details Of The Provisioning Scheme And Contains The Following Information:
Provisioningschemeuid <Guid>
The Unique Identifier For The Provisioning Scheme.
Provisioningschemename <String>
The Name Of The Provisioning Scheme.
Cpucount <Int>
The Number Of Processors That Vms Will Be Created With When Using This Scheme.
Memorymb <Int>
The Maximum Amount Of Memory That Vms Will Be Created With When Using This Scheme.
Masterimagevm <String>
The Path Within The Hosting Unit Provider To The Copy Of The Vm Snapshot That The Scheme Uses.
Masterimagevmdate <Datetime>
The Date And Time That The Copy Was Made Of The Vm Snapshot Used By The Scheme.
Identitypooluid <Guid>
The Unique Identifier Of The Identity Pool (From The Adidentity Powershell Snap-In) That The Scheme Uses.
Identitypoolname <String>
The Name Of The Identity Pool (From The Adidentity Powershell Snap-In) That The Scheme Uses.
Hostingunituid <Guid>
The Unique Identifier Of The Hosting Unit (From The Hosting Unit Powershell Snap-In) That The Scheme Uses.
Hostingunitname <String>
The Name Of The Hosting Unit (From The Hosting Unit Powershell Snap-In) That The Scheme Uses.
Cleanonboot <Boolean>
Indicates Whether The Vms That Are Created Will Be Reset To A Clean State On Each Boot.
Taskid <Guid>
The Identifier Of Any Current Task That Is Running For The Provisioning Scheme.
Metadata <Citrix.Machinecreation.Sdk.Metadata[]>
The Metadata Associated With This Provisioning Scheme.
Controlleraddress <String[]>
The Dns Names Of The Controllers Associated With This Provisioning Scheme For Quick Deploy Purposes.
Vmmetadata <Char[]>
The Opaque Vm Metadata Block
Usepersonalvdiskstorage <Bool>
True If The Scheme Will Use Personal Vdisk Storage.
Personalvdiskdriveletter <Char>
The Drive Letter For The Personal Vdisk
Personalvdiskdrivesize <Int>
The Size Of The Personal Vdisk In Gb
Profileusagepercentage <Double>
The Percentage Of The Personal Vdisk To Be Used For Profile Data
Dedicatedtenancy <Bool>
Whether To Use Dedicated Tenancy When Creating Machines In Cloud Hypervisors.
Currentmasterimageuid <Guid>
The Unique Identifier Of The Current Master Image Used By The Provisioning Scheme. (See Get-Provschememastervmimagehistory.)
Usewritebackcache <Bool>
True If The Scheme Will Use The Wrote Back Cache Feature.
Writebackcachedisksize <Int>
The Size Of The Write Back Cache Disk If Specified In Gb.
Writebackcachememorysize <Int>
The Size Of The Write Back Memory Cache If Specified In Mb.
Usefulldiskcloneprovisioning <Bool>
Indicates Whether The Machines Are Provisioned Using The Dedicated Full Disk Clone Feature.

Notes

In the case of failure, the following errors can result.
Error Codes
CouldNotQueryDatabase
The query required to get the database was not defined.
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
CommunicationError
An error occurred while communicating with the service.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.

Examples

Example 1

Import-ProvScheme -ProvisioningSchemeData $provisioningSchemeData
<!--NeedCopy-->

Description

Import the json encoded data that is in $provisioningSchemeData

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

Import-Provscheme

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Import-Provscheme

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Notes

Examples

Example 1

Description

In this article