Developer Documentation
Citrix Daas SDK

Set-VusMachineUpgrade

November 14, 2023
Contributed by: 
C

Sets scheduled time and duration for existing machine schedule

Syntax

Set-VusMachineUpgrade -MachineUuid <String[]> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-VusMachineUpgrade -MachineUuid <String[]> [-UpgradeNow] [-DurationInHours <Int32>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-VusMachineUpgrade -MachineName <String[]> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-VusMachineUpgrade -MachineName <String[]> [-UpgradeNow] [-DurationInHours <Int32>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-VusMachineUpgrade -MachineUid <Int32[]> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-VusMachineUpgrade -MachineUid <Int32[]> [-UpgradeNow] [-DurationInHours <Int32>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Set-VusMachineUpgrade cmdlet sets the scheduled time and duration for upgrade for a machine or list of machines. This affects only machines that are not in the state UpgradeInUpgradeWindow.

Parameters

Name Description Required? Pipeline Input Default Value
MachineUuid UUID of the machine or list of machines true false  
MachineName Name of the machine or list of machines true false  
MachineUid UID of the machine or list of machines true false  
ScheduledTimeInUtc Scheduled time in UTC when machine upgrade will be performed false false  
DurationInHours Hours available for upgrade false false  
UpgradeNow Switch to start upgrade at current time in UTC false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of 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

Return Values

Citrix.Vdaupdateservice.SdkMachineupgradeobject

The upgrade information for most recent machine schedule

Examples

Example 1 

C:\PS> Set-VusMachineUpgrade -MachineUuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9" -DurationInHours 6 -ScheduledTimeInUtc ([System.DateTime]::ParseExact("10/23/2021 07:00 PM", 'MM/dd/yyyy hh:mm tt', $null))
<!--NeedCopy-->

Description

Set scheduled time and duration for existing machine schedule for machine matching the given UUID.

Example 2 

C:\PS> Set-VusMachineUpgrade -MachineName "TestMachine1" -DurationInHours 6
<!--NeedCopy-->

Description

Set duration for existing machine schedule for machine matching the given name.

Example 3 

C:\PS> Set-VusMachineUpgrade -MachineName "TestMachine1" -UpgradeNow
<!--NeedCopy-->

Description

Set start time as current time for existing machine schedule for machine matching the given name.

Set-VusMachineUpgrade
November 14, 2023
Contributed by: 
C
November 14, 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.