Citrix Virtual Apps and Desktops SDK

Get-ProvSchedule

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Gets the list of Schedules created

Syntax

Get-ProvSchedule
   [-ScheduleId <Guid>]
   [-ProvisioningSchemeName <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides a filtered list of the Provisioning Schedules created using Citrix Machine Creation Services.

Examples

EXAMPLE 1

Returns all the available provisioning schedule

C:\Windows\system32> Get-ProvSchedule -ScheduleId cf57bb18-c622-4078-a370-5c1bf23e7f66


ScheduleId                             : cf57bb18-c622-4078-a370-5c1bf23e7f66
ProvisioningScheduleName               : AWSMCSVMWare
ProvisioningSchemeName                 : MCSCatalog
Operation                              : TakeBackup
ScheduleCreationTime                   : 4/8/2024 4:55:36 PM
NextScheduledMaintenanceCycleTimeInUTC : 4/8/2024 5:25:36 PM
ProvisioningScheduleActive             : False
SessionWarningInMinutes                : 35
SessionWarningLogOffMessage            : PLEASE SAVE SESSION BEFORE MACHINE IS TURNED OFF
PurgeMaintenanceCycleInfoAfterInDays   : 1
RecurringSchedule                      : Daily
ScheduleDescription                    : Backing Up VMs
MaxNumberOfBackups                     : 3
<!--NeedCopy-->

Parameters

-ScheduleId

Unique identifier for the schedule

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

-ProvisioningSchemeName

Gets the provisioning schedules associated to the provisioning scheme name

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

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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Get-ProvSchedule