Developer Documentation
Citrix Virtual Apps and Desktops SDK
2603 CR 2511 CR 2503 CR 2411 CR 2407 CR 2507 LTSR 2402 LTSR 2203 LTSR
View PDF

Set-ProvVMBackupLimit

May 4, 2026
Contributed by: 
C

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Sets the limit for number of user visible on-demand backups per machine in a provisioning scheme.

Syntax

Set-ProvVMBackupLimit
   -ProvisioningSchemeUid <Guid>
   -OnDemandBackupLimit <Int32>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Caps the number of the user visible on-demand backups allowed per machine in a provisioning scheme. Zero is interpreted as no limit. If this limit is met or exceeded, no new user-visible backups can be made. There is no limit for on-demand backups that are not user visible.

Examples

EXAMPLE 1

Set the user visible on-demand backup limit for provisioning scheme uid 378cece5-a824-41f7-9e92-74be76672be6 to 5.

Set-ProvVMBackupLimit -ProvisioningSchemeUid 378cece5-a824-41f7-9e92-74be76672be6 -OnDemandBackupLimit 5
<!--NeedCopy-->

Parameters

-ProvisioningSchemeUid

The unique identifier for the provisioning scheme

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

-OnDemandBackupLimit

The number of user visible on-demand backups allowed for machines in a provisioning scheme

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

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 2511

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.

-BackupLimit

The number of user-visible backups allowed for a given machine in a provisioning scheme

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Removed in: Citrix Virtual Apps and Desktop 7 2511

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Set-ProvVMBackupLimit
May 4, 2026
Contributed by: 
C
May 4, 2026
Contributed by: 
C

In this article

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