.TH "GCLOUD_BACKUP\-DR_BACKUP\-VAULTS_UPDATE" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud backup\-dr backup\-vaults update\fR (\fIBACKUP_VAULT\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-access\-restriction\fR=\fIACCESS_RESTRICTION\fR] [\fB\-\-no\-async\fR] [\fB\-\-backup\-min\-enforced\-retention\fR=\fIBACKUP_MIN_ENFORCED_RETENTION\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-effective\-time\fR=\fIEFFECTIVE_TIME\fR] [\fB\-\-force\-update\fR] [\fB\-\-force\-update\-access\-restriction\fR] [\fB\-\-unlock\-backup\-min\-enforced\-retention\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a Backup and DR backup vault.



.SH "EXAMPLES"

To update a backup vault BACKUP_VAULT in location MY_LOCATION with one update
field, run:

.RS 2m
$ gcloud backup\-dr backup\-vaults update BACKUP_VAULT \e
    \-\-location=MY_LOCATION \-\-effective\-time="2024\-03\-22"
.RE

To update a backup vault BACKUP_VAULT in location MY_LOCATION with multiple
update fields, run:

.RS 2m
$ gcloud backup\-dr backup\-vaults update BACKUP_VAULT \e
    \-\-location=MY_LOCATION \e
    \-\-backup\-min\-enforced\-retention="400000s" \e
    \-\-description="Updated backup vault"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Backup Vault resource \- Name of the existing backup vault to update. 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 "FLAGS"

.RS 2m
.TP 2m
\fB\-\-access\-restriction\fR=\fIACCESS_RESTRICTION\fR

Authorize certain sources and destinations for data being sent into, or restored
from the current backup vault.

Access restrictions can be modified to be more or less restrictive.

.RS 2m
::: More restrictive access restriction update will fail by default if there will be non compliant Data Sources.
To allow such updates, use the \-\-force\-update\-access\-restriction flag.
:::  For Google Cloud Console resources, the following changes are allowed to make access restrictions more restrictive:
    *   `UNRESTRICTED` to `WITHIN_PROJECT` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA` / `WITHIN_ORGANIZATION`
    *   `WITHIN_PROJECT` to `WITHIN_ORGANIZATION` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA`
.RE

.RS 2m
::: For Management Server resources, the following changes are allowed to make access restrictions more restrictive:
    *   `UNRESTRICTED` to `WITHIN_PROJECT` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA` / `WITHIN_ORGANIZATION`
    *   `WITHIN_PROJECT` to `WITHIN_ORGANIZATION` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA`
.RE

.RS 2m
:::   For both Google Cloud Console and Management Server resources, the following changes are allowed to make access restrictions more restrictive:
    *   `UNRESTRICTED` to `WITHIN_PROJECT` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA` / `WITHIN_ORGANIZATION`
    *   `WITHIN_PROJECT` to `WITHIN_ORGANIZATION` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA`
.RE

.RS 2m
::: For Google Cloud Console resources,  the following changes are allowed to make access restrictions less restrictive:
    *   `WITHIN_ORGANIZATION` to `UNRESTRICTED` / `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA`
    *   `WITHIN_PROJECT` to `UNRESTRICTED`
    *   `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA` to `UNRESTRICTED`
.RE

.RS 2m
::: For Management Server resources, the following changes are allowed to make access restrictions less restrictive:
    *   `WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA` to `UNRESTRICTED`
.RE

\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\-\-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).

.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\-\-force\-update\fR

If set, allow update to extend the minimum enforced retention for backup vault.
This overrides the restriction against conflicting retention periods. This
conflict may occur when the expiration schedule defined by the associated backup
plan is shorter than the minimum retention set by the backup vault.

.TP 2m
\fB\-\-force\-update\-access\-restriction\fR

If set, the access restriction can be updated even if there are non\-compliant
data sources. Backups for those data sources will fail afterward.

.TP 2m
\fB\-\-unlock\-backup\-min\-enforced\-retention\fR

Removes the lock on the backup minimum enforced retention period, and resets the
effective time. When unlocked, the enforced retention period can be changed at
any time. This flag is mutually exclusive with \-\-effective\-time.


.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"

Updates a Backup and DR backup vault.



.SH "NOTES"

This variant is also available:

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