Citrix Daas SDK

Set-VusMachineUpgrade

Sets scheduled time and duration for existing machine schedule

Syntax

Set-VusMachineUpgrade
   -MachineUuid <String[]>
   [-ScheduledTimeInUtc <DateTime>]
   [-DurationInHours <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusMachineUpgrade
   -MachineUuid <String[]>
   [-UpgradeNow]
   [-DurationInHours <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusMachineUpgrade
   -MachineName <String[]>
   [-ScheduledTimeInUtc <DateTime>]
   [-DurationInHours <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusMachineUpgrade
   -MachineName <String[]>
   [-UpgradeNow]
   [-DurationInHours <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusMachineUpgrade
   -MachineUid <Int32[]>
   [-ScheduledTimeInUtc <DateTime>]
   [-DurationInHours <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusMachineUpgrade
   -MachineUid <Int32[]>
   [-UpgradeNow]
   [-DurationInHours <Int32>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

Set-VusMachineUpgrade -MachineName "TestMachine1" -DurationInHours 6
<!--NeedCopy-->

EXAMPLE 3

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

Set-VusMachineUpgrade -MachineName "TestMachine1" -UpgradeNow
<!--NeedCopy-->

Parameters

-MachineUuid

UUID of the machine or list of machines

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

-MachineName

Name of the machine or list of machines

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

-MachineUid

UID of the machine or list of machines

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

-ScheduledTimeInUtc

Scheduled time in UTC when machine upgrade will be performed

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

-DurationInHours

Hours available for upgrade

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

-UpgradeNow

Switch to start upgrade at current time in UTC

Type: SwitchParameter
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

Guid

Outputs

Citrix.VdaUpdateService.Sdk.MachineUpgradeObject

The upgrade information for most recent machine schedule

Set-VusMachineUpgrade