Developer Documentation
Citrix Daas SDK

Get-VusMachineUpgradeStatus

August 18, 2023
Contributed by: 
C

Returns upgrade status of specific machine schedule

Syntax

Get-VusMachineUpgradeStatus -MachineUuid <String[]> [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusMachineUpgradeStatus -MachineName <String[]> [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusMachineUpgradeStatus -MachineUid <Int32[]> [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusMachineUpgradeStatus -CatalogUuid <String> [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusMachineUpgradeStatus -CatalogName <String> [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusMachineUpgradeStatus -CatalogUid <Int32> [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusMachineUpgradeStatus [-All] [-MachineScheduleState <MachineScheduleState>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Get-VusMachineUpgradeStatus cmdlet returns upgrade status such as: UUID, StateId, Status Message, Last state change, Scheduled Time, Duration in hours, and Upgrade Version of specific machine schedule or all machine schedules.

Machine-level schedule records are cleaned up every 14 days after the completion of schedule. The status shows the reason for upgrade failure.

Parameters

Name Description Required? Pipeline Input Default Value
MachineUuid UUID of the machine or list of UUIDs for machines provided by broker service true false  
MachineName Name of the machine or list of machine names provided by broker service true false  
MachineUid UID of the machine or list of UIDs for machines provided by broker service true false  
CatalogUuid UUID of the catalog provided by broker service to filter machines true false  
CatalogName Name of the catalog provided by broker service to filter machines true false  
CatalogUid UID of the catalog provided by broker service to filter machines true false  
MachineScheduleState Filter machines based on the ScheduleState of most recent schedule false false  
All Retrieves all records which have been previously scheduled false false  
BearerToken Specifies the bearer token assigned to 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 use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

SystemGuid

Citrix.VdaupdateserviceSdkMachineschedulestate

Return Values

Citrix.VdaupdateserviceSdkMachinestatus

The upgrade information for most recent machine schedule

Examples

Example 1 

C:\PS> Get-VusMachineUpgradeStatus -MachineUuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
<!--NeedCopy-->

Description

Return upgrade status of machine matching the Given UUID.

Example 2 

C:\PS> Get-VusMachineUpgradeStatus -MachineName "TestMachine1"
<!--NeedCopy-->

Description

Returns upgrade status of machine matching the given name

Example 3 

C:\PS> Get-VusMachineUpgradeStatus -CatalogName "WS2019Catalog"
<!--NeedCopy-->

Description

Returns upgrade status of machines in WS2019Catalog

Example 4 

C:\PS> Get-VusMachineUpgradeStatus -MachineScheduleState UpgradeFailed
<!--NeedCopy-->

Description

Returns upgrade status of machine matching the given name and machineschedule state

Get-VusMachineUpgradeStatus
August 18, 2023
Contributed by: 
C
August 18, 2023
Contributed by: 
C

In this article

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