Citrix Daas SDK

New-VusMachineUpgrade

Creates a new schedule for a machine or list of machines

Syntax

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

Description

The New-VusMachineUpgrade cmdlet creates a new schedule for a machine or list of machines.

The cmdlet syncs with broker service to determine if the machine actually is added to broker service and only then schedules the upgrade for it.

Examples

EXAMPLE 1

Create a new upgrade for the machine matching the given UUID.

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

EXAMPLE 2

Create a new upgrade for the machine matching the given UUID.

NewVusMachineUpgrade -MachineUuid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9" -UpgradeNow -DurationInHours 4
<!--NeedCopy-->

Parameters

-ScheduledTimeInUtc

Scheduled time in UTC when machine upgrade occurs

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

-DurationInHours

Hours available for upgrade

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

-MachineName

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

-MachineUid

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

-MachineUuid

Type: String[]
Position: Named
Default value: None
Required: True
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.MachineScheduleObject

Upgrade information for most recent machine schedule

New-VusMachineUpgrade