New-Vuscatalogschedule¶
Creates a new upgrade schedule for a catalog
Syntax¶
New-VusCatalogSchedule -CatalogUid <Int32> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> [-IncludeAdditionalComponents <ComponentSelection[]>] [-ExcludeComponents <ComponentSelection[]>] [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -UpgradeNow -DurationInHours <Int32> [-IncludeAdditionalComponents <ComponentSelection[]>] [-ExcludeComponents <ComponentSelection[]>] [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -UpgradeNow -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -UpgradeNow -DurationInHours <Int32> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUid <Int32> -UpgradeNow -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> [-IncludeAdditionalComponents <ComponentSelection[]>] [-ExcludeComponents <ComponentSelection[]>] [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -UpgradeNow -DurationInHours <Int32> [-IncludeAdditionalComponents <ComponentSelection[]>] [-ExcludeComponents <ComponentSelection[]>] [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -UpgradeNow -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -UpgradeNow -DurationInHours <Int32> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogUuid <String> -UpgradeNow -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> [-IncludeAdditionalComponents <ComponentSelection[]>] [-ExcludeComponents <ComponentSelection[]>] [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -UpgradeNow -DurationInHours <Int32> [-IncludeAdditionalComponents <ComponentSelection[]>] [-ExcludeComponents <ComponentSelection[]>] [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -UpgradeNow -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -UpgradeNow -DurationInHours <Int32> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>New-VusCatalogSchedule -CatalogName <String> -UpgradeNow -DurationInHours <Int32> -IncludeAdditionalComponentsXml <String> -ExcludeComponentsXml <String> [-Features <String[]>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
The New-VusCatalogSchedule cmdlet creates a new upgrade schedule for all machines in the catalog.
The service internally gets a list of VDAs that are part of this catalog and schedules an upgrade for each machine. Any machine newly added to catalog after the expansion is not scheduled.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| CatalogUid | UID of the catalog | true | false | |
| ScheduledTimeInUtc | Scheduled time in UTC for catalog schedule | true | false | |
| DurationInHours | Hours available to upgrade | true | false | |
| UpgradeNow | Switch to start upgrade at current time in UTC | true | false | |
| IncludeAdditionalComponentsXml | List of New Components(in XML format) that are to be included/added in the Upgrade. The XML Scehma definition(xsd) is provided in the examples section.ComponentId, ParameterId can be obtianed from the Get-VusComponents cmdlet. | true | false | |
| ExcludeComponentsXml | List of Installed Components that are to be excluded/omitted in the Upgrade.This parameter accepts XML string. The XML Scehma definition(xsd) is provided in the examples section. ComponentId, ParameterId can be obtianed from the Get-VusComponents cmdlet. | true | false | |
| CatalogUuid | UUID of the catalog | true | false | |
| CatalogName | Name of the catalog | true | false | |
| IncludeAdditionalComponents | List of New Components that are to be included/added in the Upgrade. This parameter accepts a List of Component PS Object. ComponentId and ParameterId can be obtianed from the Get-VusComponents cmdlet. | false | false | |
| ExcludeComponents | List of Installed Components that are to be excluded/omitted in the Upgrade. This parameter accepts a List of Component PS Object. ComponentId and ParameterId can be obtianed from the Get-VusComponents cmdlet. | false | false | |
| Features | List of string (FeatureId GUIDs) to be enabled on VDA. FeatureId can be obtained from the Get-VusComponents cmdlet | false | 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. | 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.Datetime¶
Citrix.Vdaupdateservice.Sdk.Componentselection¶
Component Information for the Selected/Excluded Component
Citrix.Vdaupdateservice.Sdk.Componentparameter¶
Feature/Parameter information for the selected feature/parameter
Return Values¶
Citrix.Vdaupdateservice.Sdk.Catalogupgrade¶
Upgrade information for catalog schedule being updated
Examples¶
Example 1¶
C:\PS> New-VusCatalogSchedule -CatalogName "Workstation catalog" -ScheduledTimeInUtc ([System.DateTime]::ParseExact("10/23/2021 07:00 PM", 'MM/dd/yyyy hh:mm tt', $null)) -DurationInHours 4
Description¶
Schedule upgrade for a catalog on specified date for specified hours.
Example 2¶
C:\PS> New-VusCatalogSchedule -CatalogName "Workstation catalog" -UpgradeNow -DurationInHours 4
Description¶
Schedule upgrade for a catalog to start right away for specified hours.
Example 3¶
C:\PS> New-VusCatalogSchedule -CatalogUid 1 -UpgradeNow -DurationInHours 2 -IncludeAdditionalComponents SCList -ExcludeComponents $ComponentC -Features $EnableA
Description¶
SCList represents the Selected Components List comprising of ComponentA and ComponentB with Component ID's indicated below, which were previously not installed on VDAs of catalog but needs to be installed/included during the VDA Upgrade. \$ComponentA = [PSCustomObject]@{ ComponentId = [System.guid]::new('396394b3-53f0-48e0-8d8c-61dad39e3f17') Parameters = \$EmptyParamList }
\$ComponentB = [PSCustomObject]@{ ComponentId = [System.guid]::new('3ce3c043-5f32-497c-9099-0e1a6dc06647') Parameters = \$EmptyParamList } \$SCList = @(\$ComponentA, \$ComponentB)
\$ComponentC Represent a Component installed on all VDAs of a Catalog but needs to be excluded during the VDA Upgrade. \$ComponentC = [PSCustomObject]@{ ComponentId = [System.guid]::new('bddec677-9afb-49f0-9908-59a64f0f54f8') Parameters = \$EmptyParamList }
\$FeatureA represents a feature that needs to be enabled on the VDAs of the catalog during the Upgrade. \$FeatureA = [PSCustomObject]@{ ParameterId = [System.guid]::new('D9167E2C-2088-4301-BFA1-698F934B4E6B') }
The above input parameters instruct the cmdlet to check if the ComponentA and ComponentB can be installed/Included for installation and ComponentC can be excluded from installation and FeatureA can be enabled on the VDAs of the Catalog with Uid 1 during the next Catalog Upgrade scheduled from VDA Upgrade Service. If this a valid selection then VUS Schedules an upgrade for catalog with Uid 1 to start right away for specified hours.
Example 4¶
C:\PS> New-VusCatalogSchedule -CatalogUid 1 -UpgradeNow -DurationInHours 2 -XmlInput -IncludeAdditionalComponentsXml $ScXml -ExcludeComponentsXml $EcXml -Features $Featureslist
Description¶
The XML Schema Definition (xsd) with which the xml string provided for parameters: IncludeAdditionalComponentsXml and ExcludeComponentsXml is validated is as given below:
The ComponentId, ParamterId, FeatureId needed can be obtained from the output of Get-VusComponentsCmdlet.
SCXml represents a ComponentList in XML String format comprising of Component with Component ID(f515acf6-a309-4fe1-8ec6-5023cd0073f4) which has a Paramter with ParameterId(9c365ddc-6e25-48a0-9390-e58c03137d8a) and ParameterValue(testval) that was previously not installed on VDAs of catalog but needs to be installed/included during the VDA Upgrade.
\$ScXml = "f515acf6-a309-4fe1-8ec6-5023cd0073f49c365ddc-6e25-48a0-9390-e58c03137d8atestval"
\$EcXml represents 2 Components in XML String format with ComponentIDs:(396394b3-53f0-48e0-8d8c-61dad39e3f17, 3ce3c043-5f32-497c-9099-0e1a6dc06647) that is installed on all VDAs of a Catalog but needs to be excluded during the VDA Upgrade.
\$EcXml = "396394b3-53f0-48e0-8d8c-61dad39e3f173ce3c043-5f32-497c-9099-0e1a6dc06647"
Features represents the List of strings (feature ID Guids) that needs to be enabled on the VDAs of the catalog during the Upgrade. \$FeatureA and FeatureB represents features that needs to be enabled on the VDAs of the catalog during the Upgrade.
\$FeatureA = '44FF6E61-E3CC-45D0-BE9B-F52B5AB72A08' \$FeatureB = 'D9167E2C-2088-4301-BFA1-698F934B4E6B'
\$FeaturesList = @(\$FeatureA,\$FeatureB)
The above input parameters instruct the cmdlet to check if the components represented by ScXml can be installed/Included for installation and Component represented by EcXml can be excluded from installation and FeatureList can be enabled on the VDAs of the Catalog during the next Catalog Upgrade scheduled from VDA Upgrade Service. If this a valid selection then VUS Schedules an upgrade for catalog with Uid 1 to start right away for specified hours.