Developer Documentation
Citrix Daas SDK

Get-VusSchedule

August 18, 2023
Contributed by: 
C

Gets upgrade schedule data.

Syntax

Get-VusSchedule [[-Uid] <Guid>] [-ComponentType <ComponentType>] [-DurationInHours <Int32>] [-EntityList <String>] [-EntityType <EntityType>] [-ScheduledTime <DateTime>] [-StateId <ScheduleState>] [-UpgradeVersion <String>] [-Property <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The VDA Update Service maintains a list of ongoing and past scheduled upgrades.

Parameters

Name Description Required? Pipeline Input Default Value
Uid A unique identifier for the data record false true (ByValue, ByPropertyName)  
ComponentType The component being upgraded through this schedule VDA/VUS false false  
DurationInHours Amount of time in hours to complete the upgrade false false  
EntityList The list of machines or catalogs schedule in this upgrade false false  
EntityType The type of entities mentioned in the EntityList parameter i.e Catalog/Machine false false  
ScheduledTime The time at which upgrade is supposed to begin false false  
StateId The current state of schedule false false  
UpgradeVersion The version the component is being upgraded to false false  
Property Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. false false  
ReturnTotalRecordCount When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Vus_Filtering for details. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell-style filter expression. See about_Vus_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of 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

SystemGuid

Citrix.Vdaupdateservice.SdkComponenttype

Return Values

Citrix.Vdaupdateservice.SdkSchedule

Examples

Example 1 

C:\PS> Get-VusSchedule -Uid "26C82B4E-A8E7-4013-8055-9110FD9FFDC9"
<!--NeedCopy-->

Description

Retrieve the information regarding a schedule

Example 2 

C:\PS> Get-VusSchedule
<!--NeedCopy-->

Description

Retrieve the list of schedules current and past

Get-VusSchedule
August 18, 2023
Contributed by: 
C
August 18, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.