px pxb suspend

Suspend px-backup resources

note

The following commands support a set of global flags that apply to all px pxb commands. For details, see the Global Flags section.

px pxb suspend backupschedule

Suspend one or more backup schedules to temporarily stop scheduled backups.

This command can suspend a specific backup schedule by name and UID, or perform bulk suspension using various filtering options. Suspended schedules will not create new backups until resumed.

Examples:

# Suspend specific backup schedule
pxb suspend backupschedule --name my-schedule --uid schedule-12345

# Suspend with a remark for audit trail
pxb suspend backupschedule --name my-schedule --remark "Suspending for maintenance window"

# Bulk suspend across all clusters for all object types
pxb suspend backupschedule --backup-object-type All --cluster-scope All --include-filter "*"

# Bulk suspend with include/exclude name filters and remark
pxb suspend backupschedule --backup-object-type All --cluster-scope All --include-filter ".*test.*" --exclude-filter "^keep-" --remark "Suspending test schedules for system upgrade"

# Suspend schedules by policy reference (matching all names)
pxb suspend backupschedule --policy-refs "maintenance-policy" --backup-object-type All --cluster-scope All --include-filter "*"

Flags

Flag	Input type	Description	Default	Required
--authtoken	string	oidc auth token	-	Optional
--backup-object-type	string	Suspend schedules by backup object type: NS|VM|All	-	Optional
--bulk-uid-check-relaxation	bool	Relax UID check for bulk operations when using name-only references (e.g., policy-refs with name only)	false	Optional
--cluster-scope	string	Cluster scope: All | name[:uid][,name2[:uid2]...]	-	Optional
--dry-run	bool	Simulate the operation without making any changes	false	Optional
--endpoint, -e	string	The endpoint of the server	-	Optional
--exclude-filter	string	Exclude filter expression for bulk suspension	-	Optional
--exclude-objects	stringSlice	Exclude specific backup schedules by name from bulk suspension	[]	Optional
--exclude-objects-file	string	YAML/JSON file containing exclude objects list	-	Optional
--file	string	YAML/JSON configuration file for bulk suspend operation	-	Optional
--include-filter	string	Include filter expression for bulk suspension	-	Optional
--include-objects	stringSlice	Include specific backup schedules by name for bulk suspension	[]	Optional
--include-objects-file	string	YAML/JSON file containing include objects list	-	Optional
--labels, -l	string	Comma separated list of labels as key-value pairs: 'k1=v1,k2=v2'	-	Optional
--name, -n	string	Name of the backup schedule to suspend	-	Optional
--orgID	string	The org id for which to query the object	default	Optional
--output, -o	string	Output format. One of: table|json|yaml|name	table	Optional
--policy-refs	stringSlice	Suspend schedules by schedule policy references (name or name:uid)	[]	Optional
--policy-refs-file	string	YAML/JSON file containing policy references list	-	Optional
--remark	string	User remark for this suspend operation	-	Optional
--tls-certificate	string	tls certificate	-	Optional
--uid, -u	string	UID of the backup schedule to suspend	-	Optional
--volume-resource-only-policy-refs	stringSlice	Suspend schedules by volumeResourceOnly policy references (name or name:uid)	[]	Optional