New-ProvVMBackupOperation

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Creates new provisioned backups for a virtual machine.
Related information
about_ProvMachineCreationSnapIn

Syntax

New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeUid <Guid>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeUid <Guid>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeUid <Guid>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeUid <Guid>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeName <String>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeName <String>
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   [-AllVMs]
   -ProvisioningSchemeName <String>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
New-ProvVMBackupOperation
   [-BackupName <String>]
   [-BackupDescription <String>]
   [-UserVisible <Boolean>]
   [-DoNotShutdownMachines]
   [-MaintenanceCycleDescription <String>]
   -VMName <String[]>
   -ProvisioningSchemeName <String>
   [-StartsNow]
   -MaxDurationInMinutes <Int32>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionWarningLogOffTitle <String>]
   [-SessionWarningLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Lets you create new backups of virtual machines, including the boot disk and hardware attributes. The machine must be created by MCS and persistent.

Examples

EXAMPLE 1

Creates backups based on the virtual machines in the provisioning scheme "MyScheme".
New-ProvVMBackupOperation -ProvisioningSchemeName MyScheme -StartsNow

EXAMPLE 2

Creates backups from virtual machines "vm01", "vm02", and "vm03" in the provisioning scheme "MyScheme".
New-ProvVMBackupOperation -ProvisioningSchemeName MyScheme -VMNames vm01,vm02,vm03 -StartsNow

Parameters

-MaxDurationInMinutes

Indicates the total allocated duration in minutes to the maintenance cycle
Type: Int32
Position: Named
Default value: 30
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-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

-ProvisioningSchemeUid

Indicates the Uid of the provisioning scheme
Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ScheduledStartTimeInUTC

Indicates the time in UTC at which the maintenance cycle will be started This must be a date time powershell object and user is expected to supply it as a parameter to the cmdlet
Type: DateTime
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ProvisioningSchemeName

Indicates the Name of the provisioning scheme
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

-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

-BackupName

The name to use for each of the backups. The name must be unique relative to other provisioned backups for the targeted virtual machine. Certain backup and machine properties can be specified in using the form '{PropertyName}'. These properties include:
  • For the Provisioned Backup:
    • CreationUTCDateTime
    • BackupVersion
    • BackupStatus
    • BackupUid
  • For the Provisioned Virtual Machine:
    • VMId
    • VMName
    • ProvisioningSchemeVersion
Type: String
Position: Named
Default value: {VMName}-{BackupUid}
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-BackupDescription

Description to use for each of the backups.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UserVisible

Sets whether the backup is visible to users. Default value is true.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-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

-MaintenanceCycleDescription

A brief overview to understand what the maintenance cycle is about
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 have the data in database after maintenance cycles goes into completed states, once the time expires the data will be purged
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SessionWarningTimeInMinutes

Buffer Time provided to the user to save date before powering down the vm by mcs
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-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

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

Inputs

None

You can't pipe objects to this cmdlet.

Outputs

Maintenance cycle associated with creating backups.