Set-VusCatalogUpgrade
Sets upgrade schedule time and duration for existing catalog schedule
Syntax
Set-VusCatalogUpgrade
-CatalogName <String>
[-ScheduledTimeInUtc <DateTime>]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusCatalogUpgrade
-CatalogName <String>
[-UpgradeNow]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusCatalogUpgrade
-CatalogUid <Int32>
[-ScheduledTimeInUtc <DateTime>]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusCatalogUpgrade
-CatalogUid <Int32>
[-UpgradeNow]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusCatalogUpgrade
-CatalogUuid <String>
[-ScheduledTimeInUtc <DateTime>]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-VusCatalogUpgrade
-CatalogUuid <String>
[-UpgradeNow]
[-DurationInHours <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Set-VusCatalogUpgrade cmdlet allows admin to set the schedule time and/or duration for existing catalog schedule.
In case the schedule is already in UpgradeInProgress state, only the VDAs that have not yet picked up the upgrade are affected. VDAs that have started to upgrade cannot be rescheduled.
Examples
EXAMPLE 1
Set upgrade time for provided catalog.
Set-VusCatalogUpgrade -CatalogName "Workstation catalog" -DurationInHours 4
EXAMPLE 2
Set upgrade time for provided catalog.
Set-VusCatalogUpgrade -CatalogName "Workstation catalog" -ScheduledTimeInUtc ([System.DateTime]::ParseExact("10/23/2021 07:00 PM", 'MM/dd/yyyy hh:mm tt', $null))
EXAMPLE 3
Change the schedule for provided catalog to start at right now.
Set-VusCatalogUpgrade -CatalogName "Workstation catalog" -UpgradeNow
Parameters
-CatalogUid
UID of the catalog provided by broker service
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CatalogUuid
UUID of the catalog provided by broker service
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CatalogName
Name of the catalog provided by broker service
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ScheduledTimeInUtc
Scheduled time in UTC for catalog schedule
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DurationInHours
Hours available to 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 |
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.CatalogUpgrade
The upgrade information for catalog schedule being updated