HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/help/man/man1/gcloud_backup-dr_backup-vaults_create.1
.TH "GCLOUD_BACKUP\-DR_BACKUP\-VAULTS_CREATE" 1



.SH "NAME"
.HP
gcloud backup\-dr backup\-vaults create \- create a Backup and DR backup vault



.SH "SYNOPSIS"
.HP
\f5gcloud backup\-dr backup\-vaults create\fR (\fIBACKUP_VAULT\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-backup\-min\-enforced\-retention\fR=\fIBACKUP_MIN_ENFORCED_RETENTION\fR [\fB\-\-access\-restriction\fR=\fIACCESS_RESTRICTION\fR;\ default="within\-org"] [\fB\-\-no\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-effective\-time\fR=\fIEFFECTIVE_TIME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a Backup and DR backup vault.



.SH "EXAMPLES"

To create a new backup vault \f5\fIBACKUP_VAULT\fR\fR in location
\f5\fIMY_LOCATION\fR\fR with minimum enforced\-retention for backups of 1 month
and 1 day, run:

.RS 2m
$ gcloud backup\-dr backup\-vaults create BACKUP_VAULT \e
    \-\-location=MY_LOCATION \-\-backup\-min\-enforced\-retention="p1m1d"
.RE

To create a new backup vault \f5\fIBACKUP_VAULT\fR\fR in location
\f5\fIMY_LOCATION\fR\fR with minimum enforced\-retention for backups of 1 day
and description \f5\fIDESCRIPTION\fR\fR, run:

.RS 2m
$ gcloud backup\-dr backup\-vaults create BACKUP_VAULT \e
    \-\-location=MY_LOCATION \-\-backup\-min\-enforced\-retention="1d" \e
    \-\-description=DESCRIPTION
.RE

To create a new backup vault \f5\fIBACKUP_VAULT\fR\fR in location
\f5\fIMY_LOCATION\fR\fR with minimum enforced\-retention for backups of 1 day
and label key1 with value value1, run:

.RS 2m
$ gcloud backup\-dr backup\-vaults create BACKUP_VAULT \e
    \-\-location=MY_LOCATION \-\-backup\-min\-enforced\-retention="1d" \e
    \-\-labels=key1=value1
.RE

To create a new backup vault \f5\fIBACKUP_VAULT\fR\fR in location
\f5\fIMY_LOCATION\fR\fR with minimum enforced\-retention for backups of 1 day
and effective\-time "2024\-03\-22", run:

.RS 2m
$ gcloud backup\-dr backup\-vaults create BACKUP_VAULT \e
    \-\-location=MY_LOCATION \-\-backup\-min\-enforced\-retention="1d" \e
    \-\-effective\-time="2024\-03\-22"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Backup Vault resource \- Name of the backup vault to create. A vault name cannot
be changed after creation. It must be between 3\-63 characters long and must be
unique within the project and location. The arguments in this group can be used
to specify the attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5backup_vault\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIBACKUP_VAULT\fR

ID of the Backup Vault or fully qualified identifier for the Backup Vault.

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_vault\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the Backup Vault.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup_vault\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-backup\-min\-enforced\-retention\fR=\fIBACKUP_MIN_ENFORCED_RETENTION\fR

Backups will be kept for this minimum period before they can be deleted. Once
the effective time is reached, the enforced retention period cannot be decreased
or removed. The value must be specified in relative time format (e.g. p1d, p1m,
p1m1d).


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-access\-restriction\fR=\fIACCESS_RESTRICTION\fR; default="within\-org"

Authorize certain sources and destinations for data being sent into, or restored
from, the backup vault being created. This choice determines the type of
resources that can be stored. Restricting access to within your project or
organization limits the resources to those managed through the Google Cloud
console (e.g., Compute Engine VMs). Unrestricted access is required for
resources managed through the management console (e.g., VMware Engine VMs,
databases, and file systems). \fIACCESS_RESTRICTION\fR must be one of:
\fBwithin\-project\fR, \fBwithin\-org\fR, \fBunrestricted\fR,
\fBwithin\-org\-but\-unrestricted\-for\-ba\fR.

.TP 2m
\fB\-\-no\-async\fR

Wait for the operation in progress to complete.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Optional description for the backup vault (2048 characters or less).

.TP 2m
\fB\-\-effective\-time\fR=\fIEFFECTIVE_TIME\fR

The time at which the enforced retention period becomes locked. This flag is
mutually exclusive with \-\-unlock\-backup\-min\-enforced\-retention.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

Optional resource labels to represent metadata provided by the user.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the backupdr/v1 API. The full documentation for this API can
be found at: https://cloud.google.com/backup\-disaster\-recovery



.SH "BRIEF"

Creates a Backup and DR backup vault.



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha backup\-dr backup\-vaults create
.RE