Set-VusMachineUpgrade
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Sets scheduled time and duration for existing machine schedule
Syntax
Set-VusMachineUpgrade
-MachineName <String[]>
[-ScheduledTimeInUtc <DateTime>]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusMachineUpgrade
-MachineName <String[]>
[-UpgradeNow]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusMachineUpgrade
-MachineUid <Int32[]>
[-ScheduledTimeInUtc <DateTime>]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusMachineUpgrade
-MachineUid <Int32[]>
[-UpgradeNow]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusMachineUpgrade
-MachineUuid <String[]>
[-ScheduledTimeInUtc <DateTime>]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusMachineUpgrade
-MachineUuid <String[]>
[-UpgradeNow]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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))
EXAMPLE 2
Set duration for existing machine schedule for machine matching the given name.
Set-VusMachineUpgrade -MachineName "TestMachine1" -DurationInHours 6
EXAMPLE 3
Set start time as current time for existing machine schedule for machine matching the given name.
Set-VusMachineUpgrade -MachineName "TestMachine1" -UpgradeNow
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 |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2507 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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
Outputs
Citrix.VdaUpdateService.Sdk.MachineUpgradeObject
The upgrade information for most recent machine schedule