Citrix Virtual Apps and Desktops SDK

Get-ProvScheme

August 3, 2023

Contributed by:

Gets a list of provisioning schemes.

Syntax

Get-ProvScheme [[-ProvisioningSchemeName] <String>] [-ProvisioningSchemeUid <Guid>] [-ScopeId <Guid>] [-ScopeName <String>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Allows you to retrieve the list of defined provisioning schemes.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The name of the provisioning scheme.	false	false
ProvisioningSchemeUid	The unique identifier of the provisioning scheme.	false	false
ScopeId	Gets only results with a scope matching the specified scope identifier.	false	false
ScopeName	Gets only results with a scope matching the specified scope name.	false	false
ReturnTotalRecordCount	See about_Prov_Filtering for details.	false	false	false
MaxRecordCount	See about_Prov_Filtering for details.	false	false	false
Skip	See about_Prov_Filtering for details.	false	false	0
SortBy	See about_Prov_Filtering for details.	false	false
Filter	See about_Prov_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	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 that the PowerShell snap-in connects to. You can provide this as a host name or an IP address.	false	false	LocalHost. When 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:

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

Notes

In the case of failure, the following errors can result.

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.

Examples

Example 1

C:\PS>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]}

ProvisioningSchemeName       : Scheme1

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

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

<!--NeedCopy-->

Description

Returns all of the available provisioning schemes.

Example 2

C:\PS>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

<!--NeedCopy-->

Description

Returns all of the provisioning schemes that have the name ‘Scheme0’ or ‘Scheme1’.

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

Get-ProvScheme

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-ProvScheme

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Machinecreation.Sdk.Provisioningscheme

Notes

Examples

Example 1

Description

Example 2

Description

In this article