Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-ProvImageScheme

March 11, 2024
Contributed by: 
C

Gets the list of image schemes.

Syntax


Get-ProvImageScheme [[-PreparedImageSchemeName] <String>] [-PreparedImageSchemeUid <Guid>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Lets you retrieve the list of defined image schemes.

Parameters

Name Description Required? Pipeline Input Default Value
PreparedImageSchemeName The name of the image scheme. false false  
PreparedImageSchemeUid The unique identifier of the image scheme. 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  
AdminClientIP Specifies the Client IP of 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 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. false false LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Machinecreation.Sdk.Imagescheme

This object provides details of the image scheme and contains the following information:

  • CpuCount <int> The number of processors that VMs will be created with when using this scheme.

  • CustomProperties <string> Properties of the scheme which that are specific to the target hosting infrastructure. (See about_ProvCustomProperties)

  • HostingUnitName <string> The name of the hosting unit (from the Hosting Unit 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.

  • MachineProfile <string> The inventory path to the source VM used by the scheme as a template.

  • MemoryMB <int> The maximum amount of memory that VMs will be created with when using this scheme.

  • NetworkMaps <Citrix.MachineCreation.Sdk.NetworkMap[]> The NIC/network mappings that will be used to create VMs.

  • PreparedImageSchemeName <string> The name of the image scheme.

  • PreparedImageSchemeUid <Guid> The unique identifier for the image scheme.

  • ServiceOffering <string> The service offering that the scheme uses when creating VMs in Cloud Hypervisors.

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

CpuCount                         : 1

CustomProperties                 :

HostingUnitName                  : Hu

HostingUnitUid                   : e5d4a2c9-6650-4cfc-93cc-1686db82b92e

MachineProfile                   :

MemoryMB                         : 1024

NetworkMaps                      : {0}

PreparedImageSchemeName          : Scheme1

PreparedImageSchemeUid           : b5a55401-ad36-4f53-b0e0-dbb6a5bdf6fd

ServiceOffering                  :

CpuCount                         : 1

CustomProperties                 :

HostingUnitName                  : Hu

HostingUnitUid                   : e5d4a2c9-6650-4cfc-93cc-1686db82b92e

MachineProfile                   :

MemoryMB                         : 1024

NetworkMaps                      : {0}

PreparedImageSchemeName          : Scheme2

PreparedImageSchemeUid           : 85bd21c6-851b-420a-a702-2fa2ee6f0052

ServiceOffering                  :

<!--NeedCopy-->

Description

Returns all of the available image schemes.

Example 2 


C:\PS>Get-ProvImageScheme -PreparedImageSchemeName Scheme[0-1]

CpuCount                         : 1

CustomProperties                 :

HostingUnitName                  : Hu

HostingUnitUid                   : e5d4a2c9-6650-4cfc-93cc-1686db82b92e

MachineProfile                   :

MemoryMB                         : 1024

NetworkMaps                      : {0}

PreparedImageSchemeName          : Scheme1

PreparedImageSchemeUid           : b5a55401-ad36-4f53-b0e0-dbb6a5bdf6fd

ServiceOffering                  :

<!--NeedCopy-->

Description

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

Get-ProvImageScheme
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.