Product Documentation

Get-ProvScheme

Sep 29, 2015

Gets the list of provisioning schemes.

Syntax

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

Detailed Description

Lets you retrieve the list of defined provisioning schemes.

Parameters

-ProvisioningSchemeName<String>

The name of the provisioning scheme.

Required? false
Default Value  
Accept Pipeline Input? false

-ProvisioningSchemeUid<Guid>

The unique identifier of the provisioning scheme.

Required? false
Default Value  
Accept Pipeline Input? false

-ScopeId<Guid>

Gets only results with a scope matching the specified scope identifier.

Required? false
Default Value  
Accept Pipeline Input? false

-ScopeName<String>

Gets only results with a scope matching the specified scope name.

Required? false
Default Value  
Accept Pipeline Input? false

-ReturnTotalRecordCount<SwitchParameter>

See about_Prov_Filtering for details.

Required? false
Default Value false
Accept Pipeline Input? false

-MaxRecordCount<Int32>

See about_Prov_Filtering for details.

Required? false
Default Value false
Accept Pipeline Input? false

-Skip<Int32>

See about_Prov_Filtering for details.

Required? false
Default Value 0
Accept Pipeline Input? false

-SortBy<String>

See about_Prov_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-Filter<String>

See about_Prov_Filtering for details.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value LocalHost. When a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

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.

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. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>Get-ProvScheme 
 
 
ProvisioningSchemeUid  : 7585f0de-192e-4847-a6d8-22713c3a2f42 
ProvisioningSchemeName : Scheme1 
CpuCount               : 1 
MemoryMB               : 1024 
MasterImageVM          : /Base.vm/base.snapshot 
MasterImageVMDate      : 17/05/2010 09:27:50 
IdentityPoolUid        : 03743136-e43b-4a87-af74-ab71686b3c16 
IdentityPoolName       : idPool1 
HostingUnitUid         : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501 
HostingUnitName        : HostUnit1 
CleanOnBoot            : True 
TaskId                 : 00000000-0000-0000-0000-000000000000 
Metadata               : {Department = Sales} 
ControllerAddress      : {} 
VMMetadata             : {0, 1, 0, 0...} 
 
ProvisioningSchemeUid  : 43d82099-1fd7-4617-93f0-25b160813905 
ProvisioningSchemeName : Scheme2 
CpuCount               : 1 
MemoryMB               : 1024 
MasterImageVM          : /Base.vm/base.snapshot 
MasterImageVMDate      : 17/05/2010 09:53:40 
IdentityPoolUid        : 03743136-e43b-4a87-af74-ab71686b3c16 
IdentityPoolName       : idPool1 
HostingUnitUid         : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501 
HostingUnitName        : HostUnit1 
CleanOnBoot            : True 
TaskId                 : 00000000-0000-0000-0000-000000000000 
Metadata               : {} 
ControllerAddress      : {} 
VMMetadata             : {0, 1, 0, 0...}

Returns all of the available provisioning schemes.

-------------------------- EXAMPLE 2 --------------------------

C:\PS>Get-ProvScheme -ProvisioningSchemeName Scheme[0-1] 
 
 
ProvisioningSchemeUid  : 7585f0de-192e-4847-a6d8-22713c3a2f42 
ProvisioningSchemeName : Scheme1 
CpuCount               : 1 
MemoryMB               : 1024 
MasterImageVM          : /Base.vm/base.snapshot 
MasterImageVMDate      : 17/05/2010 09:27:50 
IdentityPoolUid        : 03743136-e43b-4a87-af74-ab71686b3c16 
IdentityPoolName       : idPool1 
HostingUnitUid         : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501 
HostingUnitName        : HostUnit1 
CleanOnBoot            : True 
TaskId                 : 00000000-0000-0000-0000-000000000000 
Metadata               : {} 
ControllerAddress      : {} 
VMMetadata             : {0, 1, 0, 0...}

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