New-ProvVMBackupSchedule

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2407
Creates new schedules
Related information
about_ProvMachineCreationSnapIn

Syntax

New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeUid <Guid>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeUid <Guid>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeUid <Guid>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeUid <Guid>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeName <String>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeName <String>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeName <String>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupSchedule
   [-MaxNumberOfBackups <Int32>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   -ProvisioningScheduleName <String>
   -RecurringSchedule <String>
   [-ScheduleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeName <String>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Creates a new Schedule for Backing up virtual machines in a provisioning scheme via maintenance cycles

Examples

Parameters

-ProvisioningScheduleName

A Unique name provided for the provisioning schedule
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-RecurringSchedule

Indicates how frequently rhe operation needs to be run, can be daily, weekly or monthly
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-MaxDurationInMinutes

Indicates the total allocated duration in minutes to the provisioning schedule
Type: Int32
Position: Named
Default value: 30
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-VMName

An array of virtual machine names to which the maintenance cycle operation need to be executed
Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-ProvisioningSchemeUid

The Uid of the Provisioning scheme to be associated with the provisioning schedule
Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-ScheduledStartTimeInUTC

Indicates the start time for the provisioning schedule
Type: DateTime
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ProvisioningSchemeName

The name of the Provisioning scheme to be associated with the provisioning schedule
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-StartsNow

Indicates that the maintenance cycle has to be started immediately
Type: SwitchParameter
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-AllVMs

Indicate that all virtual machines in the prov scheme has to be considered by the maintenance cycle
Type: SwitchParameter
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-MaxNumberOfBackups

The maximum number of backups that can exist, per virtual machine as part of the provisioning schedule
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UserVisible

Sets whether the backups taken by this schedule are visible to users. Default value is true.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2503

-DoNotShutdownMachines

Indicates if a backup will be taken on virtual machines without shutting them down first.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2503

-ScheduleDescription

A brief overview of the provisioning schedule
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PurgeDBAfterInDays

The duration of time in days for mcs to wait before purging relevant info from the database upon completion
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-SessionWarningTimeInMinutes

Buffer Time provided to the user to save data before powering down the vm by mcs
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-SessionWarningLogOffTitle

Short Heading for the message to be displayed to the user
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-SessionWarningLogOffMessage

Brief Message intended to be displayed to the user before powering down the vm
Type: String
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.

Removed Parameters

Parameters in this section were available in older releases, and have been removed or replaced due to changes in functionality.

-MaxAllocatedDurationInMinutes

Indicates the total allocated duration in minutes to the provisioning schedule
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Removed in: Citrix Virtual Apps and Desktop 7 2411

-SessionWarningInMinutes

Buffer Time provided to the user to save data before powering down the vm by mcs
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Removed in: Citrix Virtual Apps and Desktop 7 2411

-PurgeMaintenanceCycleInfoAfterInDays

The duration of time in days for mcs to wait before purging relevant info from the database upon completion
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Removed in: Citrix Virtual Apps and Desktop 7 2411

Inputs

None

You can't pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.