Set-Vusmachineupgrade¶
Sets scheduled time and duration for existing machine schedule
Syntax¶
Set-VusMachineUpgrade -MachineUuid <String[]> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Set-VusMachineUpgrade -MachineUuid <String[]> [-UpgradeNow] [-DurationInHours <Int32>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Set-VusMachineUpgrade -MachineName <String[]> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Set-VusMachineUpgrade -MachineName <String[]> [-UpgradeNow] [-DurationInHours <Int32>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Set-VusMachineUpgrade -MachineUid <Int32[]> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Set-VusMachineUpgrade -MachineUid <Int32[]> [-UpgradeNow] [-DurationInHours <Int32>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
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.
Related Commands¶
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 | |
| 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¶
System.Guid¶
Return Values¶
Citrix.Vdaupdateservice.Sdk.Machineupgradeobject¶
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))
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
Description¶
Set duration for existing machine schedule for machine matching the given name.
Example 3¶
C:\PS> Set-VusMachineUpgrade -MachineName "TestMachine1" -UpgradeNow
Description¶
Set start time as current time for existing machine schedule for machine matching the given name.