1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-11 07:29:40 +00:00
gcloud-help/gcloud/backup-dr/backup-plan-associations/trigger-backup
2024-11-20 10:03:22 +00:00

85 lines
3.1 KiB
Text

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)
--backup-rule-id=BACKUP_RULE_ID [--async] [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-bpa in
project sample-project and location us-central1 with backup rule
sample-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 name attribute:
▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location of the Backup Plan Association.
To set the location attribute:
▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line
with a fully specified name;
▸ provide the argument --location on the command line.
--workload-project=WORKLOAD_PROJECT
Cloud project id for the Backup Plan Association.
To set the workload-project attribute:
▸ provide the argument BACKUP_PLAN_ASSOCIATION on the command line
with a fully specified name;
▸ provide the argument --workload-project on the command line;
▸ provide the argument --project on the command line;
▸ set the property core/project.
REQUIRED FLAGS
--backup-rule-id=BACKUP_RULE_ID
Name of an existing backup rule to use for creating an on-demand
backup.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete. The default is True. Enabled by default, use --no-async to
disable.
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 help for details.
BRIEF
Create an on-demand backup.
NOTES
This variant is also available:
$ gcloud alpha backup-dr backup-plan-associations trigger-backup