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!
Get-ProvScheme
Gets a list of provisioning schemes.
Syntax
Get-ProvScheme
[-ProvisioningSchemeUid <Guid>]
[[-ProvisioningSchemeName] <String>]
[-ScopeId <Guid>]
[-ScopeName <String>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Allows you to retrieve the list of defined provisioning schemes.
Examples
EXAMPLE 1
Returns all of the available provisioning schemes.
Get-ProvScheme
CleanOnBoot : True
ControllerAddress : {}
CpuCount : 1
DiskSize : 20
HostingUnitName : HostUnit1
HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
IdentityPoolName : idPool1
IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16
MachineCount : 0
MachineProfile : XDHyp:/.../Profile.vm
MasterImageVM : XDHyp:/.../Base.vm/base.snapshot
MasterImageVMDate : 17/05/2020 09:27:50
MemoryMB : 1024
Metadata : {Department = Sales}
MetadataMap : {[Department = Sales]}
PreparedImageDefinitionName :
PreparedImageVersionNumber :
PreparedImageVersionUid : 00000000-0000-0000-0000-000000000000
ProvisioningSchemeUid : 7585f0de-192e-4847-a6d8-22713c3a2f42
ProvisioningSchemeVersion : 1
TaskId : 00000000-0000-0000-0000-000000000000
VMMetadata : {0, 1, 0, 0...}
PersonalVDiskDriveLetter :
PersonalVDiskDriveSize : 0
UsePersonalVDiskStorage : False
NetworkMaps : {0}
Scopes :
DedicatedTenancy : False
GpuTypeId :
ResetAdministratorPasswords : False
SecurityGroups : {}
ServiceOffering :
TenancyType : Shared
AzureAdJoinType :
CurrentMasterImageUid : c0571690-4f57-4476-901b-fe64d6aecb79
CustomProperties :
IdentityType: : ActiveDirectory
UseFullDiskCloneProvisioning : False
UseWriteBackCache : True
WriteBackCacheDiskSize : 24
WriteBackCacheMemorySize : 256
Warnings : {}
WriteBackCacheDiskIndex : 0
WindowsActivationType : MultipleActivationKey
CleanOnBoot : True
ControllerAddress : {}
CpuCount : 1
DiskSize : 20
HostingUnitName : HostUnit1
HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
IdentityPoolName : idPool1
IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16
MachineCount : 100
MachineProfile : XDHyp:/.../Profile.vm
MasterImageVM : XDHyp:/.../Base.vm/base.snapshot
MasterImageVMDate : 17/05/2020 09:27:50
MemoryMB : 1024
Metadata : {}
MetadataMap : {}
ProvisioningSchemeUid : 43d82099-1fd7-4617-93f0-25b160813905
ProvisioningSchemeName : Scheme2
ProvisioningSchemeVersion : 1
TaskId : 00000000-0000-0000-0000-000000000000
VMMetadata : {0, 1, 0, 0...}
PersonalVDiskDriveLetter :
PersonalVDiskDriveSize : 0
UsePersonalVDiskStorage : False
NetworkMaps : {0}
Scopes :
DedicatedTenancy : False
GpuTypeId :
ResetAdministratorPasswords : False
SecurityGroups : {}
ServiceOffering :
TenancyType : Shared
AzureAdJoinType :
CurrentMasterImageUid : 022cd6e4-34cb-3f7c-e02a-44ac404483b4
CustomProperties :
IdentityType: : ActiveDirectory
UseFullDiskCloneProvisioning : False
UseWriteBackCache : True
WriteBackCacheDiskSize : 24
WriteBackCacheMemorySize : 256
Warnings : {}
WriteBackCacheDiskIndex : 0
WindowsActivationType : MultipleActivationKey
<!--NeedCopy-->
EXAMPLE 2
Returns all of the provisioning schemes that have the name ‘Scheme0’ or ‘Scheme1’.
Get-ProvScheme -ProvisioningSchemeName Scheme[0-1]
CleanOnBoot : True
ControllerAddress : {}
CpuCount : 1
DiskSize : 20
HostingUnitName : HostUnit1
HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
IdentityPoolName : idPool1
IdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16
MachineCount : 0
MachineProfile : XDHyp:/.../Profile.vm
MasterImageVM : XDHyp:/.../Base.vm/base.snapshot
MasterImageVMDate : 17/05/2020 09:27:50
MemoryMB : 1024
Metadata : {Department = Sales}
MetadataMap : {[Department = Sales]}
ProvisioningSchemeUid : 7585f0de-192e-4847-a6d8-22713c3a2f42
ProvisioningSchemeName : Scheme1
ProvisioningSchemeVersion : 1
TaskId : 00000000-0000-0000-0000-000000000000
VMMetadata : {0, 1, 0, 0...}
PersonalVDiskDriveLetter :
PersonalVDiskDriveSize : 0
UsePersonalVDiskStorage : False
NetworkMaps : {0}
Scopes :
DedicatedTenancy : False
GpuTypeId :
ResetAdministratorPasswords : False
SecurityGroups : {}
ServiceOffering :
TenancyType : Shared
AzureAdJoinType :
CurrentMasterImageUid : c0571690-4f57-4476-901b-fe64d6aecb79
CustomProperties :
IdentityType: : ActiveDirectory
UseFullDiskCloneProvisioning : False
UseWriteBackCache : True
WriteBackCacheDiskSize : 24
WriteBackCacheMemorySize : 256
Warnings : {}
WriteBackCacheDiskIndex : 0
WindowsActivationType : MultipleActivationKey
<!--NeedCopy-->
Parameters
-ProvisioningSchemeName
The name of the provisioning scheme.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ScopeId
Gets only results with a scope matching the specified scope identifier.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScopeName
Gets only results with a scope matching the specified scope name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnTotalRecordCount
See about_Prov_Filtering for details.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
See about_Prov_Filtering for details.
| Type: | Int32 |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
See about_Prov_Filtering for details.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SortBy
See about_Prov_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
See about_Prov_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| 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
Citrix.MachineCreation.Sdk.ProvisioningScheme
This object provides details of the provisioning scheme and contains the following information:
CleanOnBoot <bool>
Indicates whether the VMs created will be reset to a clean state on each start.
ControllerAddress <string[]>
The DNS names of the controllers associated with this provisioning scheme.
CpuCount <int>
The number of processors that will be used to create VMs.
DiskSize <int>
The disk size (in GB) that will be used to create VMs.
HostingUnitName <string>
The name of the hosting unit being used by this provisioning scheme.
HostingUnitUid <Guid>
The unique identifier of the hosting unit being used by this provisioning scheme.
IdentityPoolName <string>
The name of the identity pool being used by this provisioning scheme.
IdentityPoolUid <Guid>
The unique identifier of the identity pool being used by this provisioning scheme.
MachineCount <int>
The count of machines created with this provisioning scheme.
MachineProfile <string>
The inventory path to the source VM used by the provisioning scheme as a template.
MasterImageVM <string>
The inventory path to the VM snapshot copy used by this provisioning scheme.
MasterImageVMDate <DateTime>
The date and time when the VM snapshot copy used by this provisioning scheme was made.
MemoryMB <int>
The maximum amount of memory that will be used to created VMs in MB.
Metadata <Citrix.MachineCreation.Sdk.Metadata[]>
The metadata associated with this provisioning scheme.
MetadataMap <IDictionary[string, string];>
The metadata associated with this provisioning scheme arranged in key value pairs.
PreparedImageDefinitionName <string>
The name for the image definition used for the provisioning scheme.
PreparedImageVersionNumber <string>
The version number for the image version used for the provisioning scheme.
PreparedImageVersionUid <Guid>
The identifier for the image version used for the provisioning scheme.
ProvisioningSchemeName <string>
The name of this provisioning scheme.
ProvisioningSchemeUid <Guid>
The unique identifier for this provisioning scheme.
ProvisioningSchemeVersion <int>
The version of the provisioning scheme.
TaskId <Guid>
The identifier of any current task that is running for the provisioning scheme.
VMMetadata <char[]>
The metadata that will be used to created VMs in a plain text format.
PersonalVDiskDriveLetter <char>
The drive letter for the personal vDisk.
PersonalVDiskDriveSize <int>
The size of the personal vDisk in GB.
UsePersonalVDiskStorage <bool>
Indicates whether this provisioning scheme uses personal vDisk storage.
NetworkMaps <Citrix.MachineCreation.Sdk.NetworkMap[]>
The NIC/network mappings that will be used to create VMs.
Scope <Citrix.MachineCreation.Sdk.ScopeReference[]>
The administration scopes associated with this provisioning scheme.
DedicatedTenancy <bool>
Indicates whether dedicated tenancy is used when creating VMs in Cloud Hypervisors.
GpuTypeId <string>
The id of the GPU (Graphics Processor Unit) Type used by this scheme. It is null if there is no GPU.
ResetAdministratorPasswords <bool>
Indicates whether the passwords for administrator accounts are reset on created machines.
ServiceOffering <string>
The service offering that the scheme uses when creating VMs in Cloud Hypervisors.
SecurityGroups <string[]>
The security groups that will be applied to machines created in Cloud Hypervisors.
TenancyType <string>
Tenancy type to be used when creating VMs in Cloud Hypervisors. (See New-ProvScheme.)
AzureAdJoinType <string>
Deprecated.
CurrentMasterImageUid <Guid>
The unique identifier of the current master image used by the provisioning scheme. (See Get-ProvSchemeMasterVMImageHistory.)
CustomProperties <string>
Properties of the provisioning scheme which that are specific to the target hosting infrastructure. (See about_ProvCustomProperties)
IdentityType <string>
Identity type used to join created machines to a directory service. (See New-ProvScheme.)
UseFullDiskCloneProvisioning <bool>
Indicates whether VMs will be created using the dedicated full disk clone feature.
UseWriteBackCache <bool>
Indicates whether this provisioning scheme will use the write-back cache feature.
WriteBackCacheDiskSize <int>
The size of the write-back cache disk to be used in GB. Specify only when UseWriteBackCache is true.
WriteBackCacheMemorySize <int>
The size of the write-back memory cache in MB. Specify only when UseWriteBackCache is true.
Warnings <Citrix.MachineCreation.Sdk.ProvSchemeWarning[]>
Warning states that have occurred with this provisioning scheme.
WriteBackCacheDiskIndex <int>
The disk index for the write-back cache disk. Specify only when UseWriteBackCache is true.
WindowsActivationType <string>
Windows Activation Type set on the Master Image which has a mapping with the Provisioning Scheme.This feature is supported from 2303 and successive VDA versions. Any previous VDA version or if the vda is not of Windows Operating System Type, the field would be “UnsupportedVDA”
Notes
In the case of failure, the following errors can result.
Error Codes
PartialData
Only a subset of the available data was returned
CouldNotQueryDatabase
The query 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.
InvalidFilter
A filtering expression was supplied that could not be interpreted for this cmdlet.
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.
Related Links
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.