-
-
-
-
-
-
-
-
-
-
-
New-ProvScheme
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
New-Provscheme
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>] [-CustomProperties <String>] [-ResetAdministratorPasswords] [-FunctionalLevel <String>] [-UseFullDiskCloneProvisioning] [-RunAsynchronously] [-PurgeJobOnSuccess] [-InitialBatchSizeHint <Int32>] [-LoggingId <Guid>] [-BearerToken <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>] [-CustomProperties <String>] [-ResetAdministratorPasswords] [-FunctionalLevel <String>] [-UseFullDiskCloneProvisioning] [-RunAsynchronously] [-PurgeJobOnSuccess] [-InitialBatchSizeHint <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
Lets you 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 for this cmdlet to be used.
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 virtual machines created from the provisioning scheme.
Related Commands
Parameters
Input Type
Return Values
System.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 <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 Task. For New Provisioning Scheme Tasks, This Is Always Newprovisioningscheme.
Metadata <Citrix.Machinecreation.Sdk.Metadata[]>
The List Of Metadata Stored Against The Task. For New Tasks, This Is Empty Until Metadata Is Added.
Workflowstatus <System.Workflow.Runtime.Workflowstatus>
Indicates The Status Of The Workflow That Is 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 Vm Image For The Task.
Identitypoolname <String>
The Name Of The Identity Pool (From The Adidentity Powershell Snap-In) That The New Provisioning Scheme Uses.
Identitypooluid <Guid>
The Unique Identifier Name Of The Identity Pool (From The Adidentity Powershell Snap-In) That The New Provisioning Scheme Uses.
Hostingunitname <String>
The Name Of The Hosting Unit (From The Hosting Unit Powershell Snap-In) That The New Provisioning Scheme Uses.
Hostingunituid
The Unique Identifier Of The Hosting Unit (From The Hosting Unit Powershell Snap-In) That The New Provisioning Scheme Uses.
Personalvdiskdriveletter
The Drive Letter On Which A Personal Vdisk Is Mounted (Blank If The Personal Vdisk Feature Was Not Selected).
Personalvdiskdrivesize
The Size Of Any Personal Vdisk (Zero If The Personal Vdisk Feature Was Not Selected).
Writebackcachedisksize
The Size Of Any Write Back Cache Disk (Zero If The Write Back Cache Feature Was Not Selected).
Writebackcachememorysize
The Size Of The Write Back Cache (Zero If The Write Back Cache Feature Was Not Selected).
Scopes <Citrix.Fma.Sdk.Servicecorescopereference[]>
The Delegated Administration Scopes To Which The Scheme Will Belong.
Networkmap <Citrix.Machinecreation.Sdk.Networkmap>
The List Of Nic To Network Associations, If Specified.
Usefulldiskcloneprovisioning <Boolean>
Indicates Whether The Machines Are Provisioned Using The Dedicated Full Disk Clone Feature.
Provisioningschememetadata <Dictionary<String, String>>
The Metadata To Apply To The Provisioning Scheme, If Specified.
Taskstate <Citrix.Machinecreation.Sdk.Newprovisioningschemestate>
The State Of The Task. This Can Be Any Of The Following:
Processing
The Task Has Begun But Has Not Done Anything Yet.
Locatingresources,
The Workflow Is Locating Resources From Other Services.
Hostingunitnotfound
The Task Failed Because The Required Hosting Unit Could Not Be Located.
Virtualmachinesnapshotnotfound
The Task Failed Because The Required Vm Snapshot Or Vm Template Could Not Be Located.
Consolidatingmasterimage
The Task Is Consolidating The Master Image.
Replicatingconsolidatedimagetoallstorage
The Task Is Replicating The Consolidated Master Image.
Storingprovisioningscheme
The Task Is Storing The Provisioning Scheme Data In The Database.
Finished
The Task Completed With No Errors.
Provisioningschemealreadyexists
The Task Failed Because A Provisioning Scheme With The Same Name Already Exists.
Identitypoolnotfound
The Task Failed Because The Specified Identity Pool Could Not Be Found.
Mastervmimageisnotpartofprovisioningschemehostingunit,
The Task Failed Because The Hosting Unit From Which The Master Image Originated Is Not The Same Hosting Unit That The Provisioning Scheme Is Using.
Mastervmimageisnotasnapshot
The Task Failed Because The Master Vm Path Does Not Refer To A Snapshot Or Vm Template Item.
Provisioningschemenotfound
The Task Failed Because It Could Not Find A Provisioning Scheme With The Specified Name.
Taskalreadyrunningforprovisioningscheme
The Task Failed Because A Task For A Provisioning Scheme With The Same Name Is Already Running.
Invalidmastervmconfiguration
The Task Failed Because The Vm Snapshot Or Vm Template Specified As The Master Has An Invalid Configuration.
Invalidmastervmstate
The Task Failed Because The Vm Snapshot Or Vm Template Specified As The Master Is Currently In An Invalid State.
Insufficientresources
The Task Failed Because The Hypervisor Did Not Have Enough Resources To Complete The Task.
Diskconsolidationfailed
The Disk Consolidation Task Failed. Details Are In The Task State Information String.
Storagenotfound
The Task Failed Because No Associated Storage Was Found In The Hosting Unit.
Configurationerror
The Task Failed Because The Service Is Unable To Contact One Of The Other Services. This Is Because Not All Appropriate Configuration Service Registrations Have Been Performed.
Requestedfeaturenotenabled
The Task Failed Because A Requested Feature Is Not Enabled.
Canceled
The Task Was Stopped By User Intervention (Using Stop-Provtask).
Taskstateinformation
Additional Information About The Current Task State.
Taskprogress
The Progress Of The Task 0-100%.
Disksize
The Size Of The Master Image In Gb
Dedicatedtenancy
Whether To Use Dedicated Tenancy When Creating Machines In Cloud Hypervisors.
Tenancytype
Type Of Tenancy Shared, Instance Or Host Wheen Creating Machines In Cloud Hypervisors.
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.
Error Codes
———–
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. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop 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.
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
Active : False
Host : MyHost
DateStarted : 17/05/2010 08:22:22
Type : NewProvisioningScheme
Metadata : {}
WorkflowStatus : Completed
ProvisioningSchemeName : XenPS
MasterImage : /Base.vm/Base.snapshot
IdentityPoolName : idPool1
IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16
HostingUnitName : XenHU
HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
PersonalVDiskDriveLetter :
PersonalVDiskDriveSize : 0
ProvisioningSchemeUid : 7585f0de-192e-4847-a6d8-22713c3a2f42
CurrentOperation :
TaskState : Finished
TaskStateInformation :
TaskProgress : 100
DiskSize : 24
<!--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><br>i.e.<br>C:\PS>Get-ProvTask -TaskID 6dd85fec-96cf-46b1-9cd4-d8ba7d06e85b<br>TaskId : 6dd85fec-96cf-46b1-9cd4-d8ba7d06e85b<br>Active : False<br>Host : MyHost<br>DateStarted : 17/05/2010 08:22:22<br>Type : NewProvisioningScheme<br>Metadata : {}<br>WorkflowStatus : Completed<br>ProvisioningSchemeName : XenPS<br>MasterImage : XDHyp:\HostingUnits\XenHU\Base.vm\Base.snapshot<br>IdentityPoolName : idPool1<br>IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16<br>HostingUnitName : XenHU<br>HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br>PersonalVDiskDriveLetter :<br>PersonalVDiskDriveSize : 0<br>ProvisioningSchemeUid : 7585f0de-192e-4847-a6d8-22713c3a2f42<br>TaskState : Finished<br>TaskStateInformation :<br>TaskProgress : 100<br>DiskSize : 24
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<br>For example:<br>C:\PS>$provScheme<br>TaskId : d726222a-04b5-4098-b9ac-db85ed9d351b<br>Active : False<br>Host : MyHost<br>DateStarted : 12/09/2011 09:30:04<br>Type : NewProvisioningScheme<br>Metadata : {}<br>ProvisioningSchemeName : XenPS2<br>IdentityPoolName : idPool1<br>IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16<br>HostingUnitName : XenHU<br>HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br>PersonalVDiskDriveLetter : X<br>PersonalVDiskDriveSize : 17<br>WorkflowStatus : Completed<br>MasterImage : XDHyp:\HostingUnits\XenHU\Base.vm\Base.snapshot<br>ProvisioningSchemeUid : 7585f0de-192e-4847-a6d8-22713c3a2f42<br>TaskState : Finished<br>TaskStateInformation :<br>TaskProgress : 100<br>DiskSize : 24
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.