Citrix Daas SDK

Get-ProvImageScheme

Gets the list of image schemes.

Syntax

Get-ProvImageScheme
   [-PreparedImageSchemeUid <Guid>]
   [[-PreparedImageSchemeName] <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Lets you retrieve the list of defined image schemes.

Examples

EXAMPLE 1

Returns all of the available image schemes.

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

EXAMPLE 2

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

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

Parameters

-PreparedImageSchemeName

The name of the image scheme.

Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-PreparedImageSchemeUid

The unique identifier of the image scheme.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

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

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.

Get-ProvImageScheme