Citrix Daas SDK

Get-ProvVMHardwareUpdate

May 28, 2025

Contributed by:

Gets the list of Provisioned Vm Hardware Update Maintenance Cycles

Syntax

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

Description

Provides the ability to obtain a list of the Hardware Update Maintenance Cycles that were created using Citrix Machine Creation Services.

Examples

EXAMPLE 1

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

Get-ProvVMHardwareUpdate

MaintenanceCycleId           : c623e7e3-6618-4bb0-9d94-edf339b0d05f
MaintenanceCycleDescription  :
ScheduledStartTimeInUTC      : 1/21/2025 10:15:58 AM
ScheduledCompletionTimeInUTC : 1/21/2025 12:15:58 PM
MaxDurationInMinutes         : 120
Operation                    : HardwareVmUpdate
ProvisioningSchemeName       : test
ProvisioningSchemeUid        : 4091679f-4e34-4396-adac-0cf124159694
PurgeDBAfterInDays           : 30
SessionWarningTimeInMinutes  : 0
MaintenanceCycleStatus       : Completed
FailedVirtualMachines        : {}
SessionLogOffMessage         : Scheduled Maintenance
SessionLogOffMessageInfo     : "Please save your outstanding work to prevent dataloss, the machine needs to be powered off soon for scheduled maintenance, Thank You"
ScheduleId                   : 00000000-0000-0000-0000-000000000000
AllVMs                       : False
VMName                       : {new02}
TargetProvSchemeVersion      : 2
TargetProvVmConfiguration    : 0
<!--NeedCopy-->

Parameters

-MaintenanceCycleId

The unique identifier of the maintenance cycle.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
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:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ProvisioningSchemeUid

Gets the maintenance cycle associated to the provisioning scheme uid

Type:	String
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 maintenance cycle and contains the following document

ProvisioningSchemeName < string>

The scheme name associated with the maintenance cycle object

ProvisioningSchemeUid < Guid>

The scheme uid associated with the maintenance cycle object

MaintenanceCycleDescription < string>

A brief overview to understand what the maintenance cycle is about

MaintenanceCycleId < Guid>

Unique identifier to identify the maintenance cycle

MaintenanceCycleStatus < string>

Indicates the status at which the maintenance cycle is currently at

Operation < string>

Indicates the operation associated to the maintenance cycle

MaxDurationInMinutes < int>

Max duration in minutes allocated for the maintenance cycle

PurgeDBAfterInDays < int>

Max duration in Days after which maintenance cycle results will be purged from the database

Defaulted to 30

ScheduledStartTimeInUTC < datetime>

Scheduled start time in UTC for the maintenance cycle

ScheduledCompletionTimeInUTC < datetime>

Scheduled Completion time in UTC for the maintenance cycle

SessionLogOffMessage < string>

A brief message intended to the user

SessionLogOffMessageInfo < string>

A crisp Message intended to be displayed as a heading to the user before powering down the vm

SessionWarningTimeInMinutes < int>

Buffer Time provided to the user to save date before powering down the vm by mcs

ScheduleId < Guid>

Unique identifier for the provisioning schedule

FailedVirtualMachines < string[]>

Indicates the machines that have failed in the maintenance cycle

AllVMs < bool>

Indicate that all virtual machines in the prov scheme has to be considered by the maintenance cycle

VMName < string[]>

An array of virtual machine names to which the maintenance cycle operation need to be executed

TargetProvSchemeVersion < int>

Provisioning Scheme Version to be set to

TargetProvVmConfiguration < int>

Provisioned Vm Configuration Version to be set to

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

May 28, 2025

Contributed by:

May 28, 2025

Contributed by:

Get-ProvVMHardwareUpdate

Syntax

Description

Examples

EXAMPLE 1

Parameters

-MaintenanceCycleId

-ProvisioningSchemeName

-ProvisioningSchemeUid

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.MaintenanceCycle

Related Links

In this article