Citrix Daas SDK

Get-VusSchedule

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>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

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

Examples

EXAMPLE 1

Retrieve the information regarding a schedule

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

EXAMPLE 2

Retrieve the list of schedules current and past

Get-VusSchedule
<!--NeedCopy-->

Parameters

-Uid

A unique identifier for the data record

Type: Guid
Position: 2
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ComponentType

The component being upgraded through this schedule VDA/VUS

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

-DurationInHours

Amount of time in hours to complete the upgrade

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

-EntityList

The list of machines or catalogs schedule in this upgrade

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

-EntityType

The type of entities mentioned in the EntityList parameter i.e Catalog/Machine

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

-ScheduledTime

The time at which upgrade is supposed to begin

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

-StateId

The current state of schedule

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

-UpgradeVersion

The version the component is being upgraded to

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

-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.

Type: String[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Vus_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

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

Guid

Citrix.VdaUpdateService.Sdk.ComponentType

Outputs

Citrix.VdaUpdateService.Sdk.Schedule

Get-VusSchedule