- NAME
-
- gcloud backup-dr backup-plan-associations trigger-backup - create an on-demand backup for a resource
- SYNOPSIS
-
-
gcloud backup-dr backup-plan-associations trigger-backup(BACKUP_PLAN_ASSOCIATION:--location=LOCATION--workload-project=WORKLOAD_PROJECT) [--async] [--labels=[KEY=VALUE, …]] [--backup-rule-id=BACKUP_RULE_ID|--custom-retention-days=CUSTOM_RETENTION_DAYS] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Create an on-demand backup for a resource. Trigger an on demand backup for the given backup rule.
- EXAMPLES
- To trigger an on demand backup for a backup plan association
sample-bpain projectsample-projectand locationus-central1with backup rulesample-backup-rule, run:gcloud backup-dr backup-plan-associations trigger-backup sample-bpa --project = sample-project --location = us-central1 --backup-rule-id = sample-backup-rule - POSITIONAL ARGUMENTS
-
- Backup Plan Association resource - Name of an existing backup plan association
to use for creating an on-demand backup. The arguments in this group can be used
to specify the attributes of this resource.
This must be specified.
-
BACKUP_PLAN_ASSOCIATION - ID of the Backup Plan Association or fully qualified identifier for the Backup
Plan Association.
To set the
nameattribute:- provide the argument
BACKUP_PLAN_ASSOCIATIONon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- provide the argument
-
--location=LOCATION - The location of the Backup Plan Association.
To set the
locationattribute:- provide the argument
BACKUP_PLAN_ASSOCIATIONon the command line with a fully specified name; - provide the argument
--locationon the command line.
- provide the argument
-
--workload-project=WORKLOAD_PROJECT - Cloud project id for the Backup Plan Association.
To set the
workload-projectattribute:- provide the argument
BACKUP_PLAN_ASSOCIATIONon the command line with a fully specified name; - provide the argument
--workload-projecton the command line; - provide the argument
--projecton the command line; - set the property
core/project.
- provide the argument
-
- Backup Plan Association resource - Name of an existing backup plan association
to use for creating an on-demand backup. The arguments in this group can be used
to specify the attributes of this resource.
- FLAGS
-
-
--async - Return immediately, without waiting for the operation in progress to complete.
The default is
True. Enabled by default, use--no-asyncto disable. -
--labels=[KEY=VALUE,…] - Labels to be applied to the backup.
- At most one of these can be specified:
-
--backup-rule-id=BACKUP_RULE_ID - Name of an existing backup rule to use for creating an on-demand backup.
-
--custom-retention-days=CUSTOM_RETENTION_DAYS - Duration for which backup data will be retained.
-
-
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - BRIEF
- Create an on-demand backup.
- NOTES
- These variants are also available:
gcloud alpha backup-dr backup-plan-associations trigger-backupgcloud beta backup-dr backup-plan-associations trigger-backup
gcloud backup-dr backup-plan-associations trigger-backup
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.

