Citrix Daas SDK

Get-ProvVMVersion

May 28, 2025

Contributed by:

Gets the list of Provisioned Vm Versions

Syntax

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

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

Description

Provides the ability to obtain a list of the vm versions that were created using MCS HardwareVmUpdate maintenance cycles

Examples

EXAMPLE 1

Returns all of the available maintenance cycles for hardware scheme update operation

Get-ProvVMVersion

ADAccountSid               : S-1-5-21-1369695582-2951410066-511316603-110984
CpuCount                   : 4
CustomProperties           :
MachineProfile             :
MemoryInMB                 : 4096
NetworkMaps                : {0}
ProvVMVersion              : 2
ProvVmConfigurationVersion : 0
ProvisioningSchemeName     : test
ProvisioningSchemeUid      : 4091679f-4e34-4396-adac-0cf124159694
ProvisioningSchemeVersion  : 2
ServiceOffering            :
VMId                       : 42268c88-47bc-b606-19cf-4cd047dc4811
VMName                     : new02
VersionCreatedTimeInUTC    : 1/21/2025 2:16:58 AM
WriteBackCacheDiskSize     :
WriteBackCacheMemorySize   :
<!--NeedCopy-->

Parameters

-ADAccountSid

The unique identifier of the Provisioned Virtual Machine

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

-VMName

Provisioned Virtual Machine Name to be filtered for the vm history information

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

-ProvisioningSchemeName

Gets the maintenance cycle associated to the provisioning scheme name

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

-ProvVMVersion

Provisioned Virtual Machine Version to be filtered for the vm history information

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

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxRecordCount

Specifies the maximum number of records to return.

Type:	Int32
Position:	Named
Default value:	250
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type:	String
Position:	Named
Default value:	The default sort order is by name or unique identifier.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

Gets records that match a PowerShell-style filter expression. 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.MaintenanceCycle

This object provides the details of the Provisioned Vm History and contains the following document

ADAccountSid < string>

Unique Sid of the provisioned virtual machine

CpuCount < int>

The number of processors that will be used to create VMs from the provisioning scheme, replacing the present one.

CustomProperties < string>

The properties of the provisioning scheme that are specific to the target hosting infrastructure. See about_Prov_CustomProperties for more information. If a property name already exists its value is updated; otherwise it is added

MachineProfile < string>

Defines the inventory path to the source VM used by the provisioning scheme as a template. This profile identifies the properties for the VMs created from the scheme. The VM must be in the hosting unit that HostingUnitName or HostingUnitUid refers to. If any properties are present in the MachineProfile but not the CustomProperties, values from the template will be written back to the CustomProperties.See about_Prov_MachineProfile for more details.

MemoryInMB < int>

The amount of memory that will be used to created VMs from the provisioning scheme in MB, replacing the present one

NetworkMaps < string>

Specifies how the attached NICs are mapped to networks. If this parameter is omitted, the current NICs setting of the provisioning scheme is not updated; otherwise the NICs setting is updated, and new machines will be created with the number of NICs specified in the map, with each NIC attached to the specified network. Cannot set to an empty value.

ProvVMVersion < int>

Vm Version of the vm in the vm history table

ProvVmConfigurationVersion < int>

The configuration version associated to the virtual machine

ProvisioningSchemeName < string>

The scheme name associated with the vm

ProvisioningSchemeUid < Guid>

The scheme uid associated with the vm

ProvisioningSchemeVersion < int>

The provisioning scheme version associated to the virtual machine

ServiceOffering < string>

The Service Offering to use when creating VMs in Cloud Hypervisors, replacing the present one. Cannot be used alongside either VMCpuCount or VMMemoryMB.

VMId < Guid>

Unique Id of the vm

VMName < string>

Unique name of the vm

VersionCreatedTimeInUTC < datetime>

Time in UTC when the version was created

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

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

May 28, 2025

Contributed by:

May 28, 2025

Contributed by:

Get-ProvVMVersion

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ADAccountSid

-VMName

-ProvisioningSchemeName

-ProvVMVersion

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.MaintenanceCycle

Related Links

In this article