Citrix Daas SDK

Get-ProvSchemeVersion

May 28, 2025

Contributed by:

Gets saved provisioning scheme configuration versions

Syntax

Get-ProvSchemeVersion
   [-ProvisioningSchemeName] <String>
   [-Version <Int32>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-ProvSchemeVersion
   [-ProvisioningSchemeUid] <Guid>
   [-Version <Int32>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to list saved provisioning scheme configuration versions.

Examples

EXAMPLE 1

Configurations are listed for provisioning scheme AzureCatalog

Get-ProvSchemeVersion -ProvisioningSchemeName AzureCatalog
            ConfigurationInfo        : Created as part of creating the provisioning scheme
            CpuCount               : 2
            CustomProperties       : 
            LastAppliedTimeInUTC     : 1/21/2025 2:04:21 AM
            MachineProfile         : machineprofile.folder\matspo.resourcegroup\matspo-vm.templatespec\hibernate-2nic-fix.templatespecversion
            MemoryInMB             : 14336
            NetworkMaps            : {0, 1}
            ProvisioningSchemeName : AzureCatalog
            ProvisioningSchemeUid  : 5b37b311-fa3f-49dd-b93b-661b9e6fa571
            SecurityGroups         : {}
            ServiceOffering        : serviceoffering.folder\Standard_D2s_v5.serviceoffering
            State                  : InUse
            VMMetadata             : {, , ,  ...}
            Version                : 2
            VersionCreatedTimeInUTC  : 1/21/2025 2:04:21 AM
            WriteBackCacheDiskSize   : 0
            WriteBackCacheMemorySize : 0

            ConfigurationInfo        : Created as part of creating the provisioning scheme
            CpuCount               : 2
            CustomProperties       : 
            LastAppliedTimeInUTC     : 1/21/2025 2:04:21 AM
            MachineProfile         : machineprofile.folder\matspo.resourcegroup\matspo-vm.templatespec\hibernate-2nic-fix.templatespecversion
            MemoryInMB             : 14336
            NetworkMaps            : {0, 1}
            ProvisioningSchemeName : AzureCatalog
            ProvisioningSchemeUid  : 5b37b311-fa3f-49dd-b93b-661b9e6fa571
            SecurityGroups         : {}
            ServiceOffering        : serviceoffering.folder\Standard_D2s_v5.serviceoffering
            State                  : InUse
            VMMetadata             : {, , ,  ...}
            Version                : 1
            VersionCreatedTimeInUTC  : 1/21/2025 2:04:21 AM
            WriteBackCacheDiskSize   : 0
            WriteBackCacheMemorySize : 0
<!--NeedCopy-->

EXAMPLE 2

Version 2 is listed for provisioning scheme AzureCatalog

Get-ProvSchemeVersion -ProvisioningSchemeName AzureCatalog -Version 2
            ConfigurationInfo        : Created as part of creating the provisioning scheme
            CpuCount               : 2
            CustomProperties       : 
            LastAppliedTimeInUTC     : 1/21/2025 2:04:21 AM
            MachineProfile         : machineprofile.folder\matspo.resourcegroup\matspo-vm.templatespec\hibernate-2nic-fix.templatespecversion
            MemoryInMB             : 14336
            NetworkMaps            : {0, 1}
            ProvisioningSchemeName : AzureCatalog
            ProvisioningSchemeUid  : 5b37b311-fa3f-49dd-b93b-661b9e6fa571
            SecurityGroups         : {}
            ServiceOffering        : serviceoffering.folder\Standard_D2s_v5.serviceoffering
            State                  : PreviouslyApplied
            VMMetadata             : {, , ,  ...}
            Version                : 2
            VersionCreatedTimeInUTC  : 1/21/2025 2:04:21 AM
            WriteBackCacheDiskSize   : 0
            WriteBackCacheMemorySize : 0
<!--NeedCopy-->

Parameters

-ProvisioningSchemeUid

Filter by the unique identifier of the provisioning scheme.

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

-ProvisioningSchemeName

Filter by the name of the provisioning scheme.

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

-Version

Filter by the version of the provisioning scheme

Type:	Int32
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.ProvisioningSchemeVersion

The object has the following properties:

Version <int>

The current version of the configuration

CpuCount <int>

The number of processors allocated to VMs in the provisioning scheme.

MemoryInMB <int>

The maximum amount of memory allocated to VMs in the provisioning scheme.

CustomProperties <string>

Properties of the provisioning scheme which that are specific to the target hosting infrastructure. (See about_Prov_CustomProperties)

ServiceOffering <string>

The service offering that the scheme uses when creating VMs in cloud hypervisors.

MachineProfile <string>

The inventory path to the source VM used by the provisioning scheme as a template.

VMMetadata <char[]>

The metadata that will be used to created VMs in a plain text format.

ProvisioningSchemeName <string>

The name of the provisioning scheme associated with the VM.

ProvisioningSchemeUid <Guid>

The unique identifier of the provisioning scheme associated with the VM.

NetworkMaps <Citrix.MachineCreation.Sdk.NetworkMap[]>

The NIC/network mappings that will be used to create VMs.

SecurityGroups <string[]>

The security groups that will be applied to machines created in Cloud Hypervisors.

State < string>

Indicates if the configuration is actively applied

VersionCreatedTimeInUTC < datetime>

Time in UTC when the Version was created

LastAppliedTimeInUTC < datetime>

Time in UTC when the configuration was applied most recently

WriteBackCacheDiskSize < int>

Specifies the size in Gigabytes of the disk to use as a Write Back Cache when UseWriteBackCache is set during the Provisioning Scheme creation. This parameter can only be set or modified if the Provisioning Scheme was previously created with UseWriteBackCache. This parameter only applies to newly created VMs and does not affect VMs which have already been created from the Provisioning Scheme.Setting this parameter to 0 is not allowed.

WriteBackCacheMemorySize < int>

Specifies the size in Megabytes of the memory to use as a Write Back Cache when UseWriteBackCache is set during the Provisioning Scheme creation. This parameter can only be set or modified if the Provisioning Scheme was previously created with UseWriteBackCache. This parameter only applies to newly created VMs and does not affect VMs which have already been created from the Provisioning Scheme

ConfigurationInfo < string>

Detailed information about the configuration created

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

May 28, 2025

Contributed by:

May 28, 2025

Contributed by:

Get-ProvSchemeVersion

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ProvisioningSchemeUid

-ProvisioningSchemeName

-Version

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.ProvisioningSchemeVersion

Related Links

In this article