.TH "GCLOUD_BACKUP\-DR_BACKUPS_RESTORE_DISK" 1



.SH "NAME"
.HP
gcloud backup\-dr backups restore disk \- restores a Compute Disk Backup



.SH "SYNOPSIS"
.HP
\f5gcloud backup\-dr backups restore disk\fR (\fIBACKUP\fR\ :\ \fB\-\-backup\-vault\fR=\fIBACKUP_VAULT\fR\ \fB\-\-data\-source\fR=\fIDATA_SOURCE\fR\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-name\fR=\fINAME\fR \fB\-\-target\-project\fR=\fITARGET_PROJECT\fR [\fB\-\-access\-mode\fR=\fIACCESS_MODE\fR] [\fB\-\-architecture\fR=\fIARCHITECTURE\fR] [\fB\-\-async\fR] [\fB\-\-confidential\-compute\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-guest\-os\-features\fR=[\fIGUEST_OS_FEATURES\fR,...]] [\fB\-\-kms\-key\fR=\fIKMS_KEY\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-licenses\fR=\fILICENSE\fR,[\fILICENSE\fR,...]] [\fB\-\-provisioned\-iops\fR=\fIPROVISIONED_IOPS\fR] [\fB\-\-provisioned\-throughput\fR=\fIPROVISIONED_THROUGHPUT\fR] [\fB\-\-replica\-zones\fR=\fIZONE\fR,\fIZONE\fR] [\fB\-\-resource\-policies\fR=\fIRESOURCE_POLICY\fR,[...]] [\fB\-\-size\fR=\fISIZE\fR] [\fB\-\-storage\-pool\fR=\fISTORAGE_POOL\fR] [\fB\-\-target\-region\fR=\fITARGET_REGION\fR] [\fB\-\-target\-zone\fR=\fITARGET_ZONE\fR] [\fB\-\-type\fR=\fITYPE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Restores a Compute Disk Backup.



.SH "EXAMPLES"

To restore a backup \f5sample\-backup\fR in project \f5sample\-project\fR and
location \f5us\-central1\fR, with \f5sample\-data\-store\fR and
\f5sample\-backup\-vault\fR, and additional target properties, run:

.RS 2m
$ gcloud backup\-dr backups restore disk sample\-backup \e
    \-\-project=sample\-project \-\-location=us\-central1 \e
    \-\-backup\-vault=sample\-backup\-vault \e
    \-\-data\-source=sample\-data\-source \-\-<target\-properties>
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Backup resource \- The backup of a resource to be restored. 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\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\fR

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

To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\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\-\-backup\-vault\fR=\fIBACKUP_VAULT\fR

The ID of the Backup Vault.

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

.TP 2m
\fB\-\-data\-source\fR=\fIDATA_SOURCE\fR

The ID of the Data Source.

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

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

The location of the Backup.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\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\-\-name\fR=\fINAME\fR

Name of the restored Disk.

.TP 2m
\fB\-\-target\-project\fR=\fITARGET_PROJECT\fR

Project where the restore should happen.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-access\-mode\fR=\fIACCESS_MODE\fR

Specifies how VMs attached to the disk can access the data on the disk. To grant
read\-only access to multiple VMs attached to the disk, set access\-mode to
READ_ONLY_MANY. To grant read\-write access to only one VM attached to the disk,
use READ_WRITE_SINGLE. READ_WRITE_SINGLE is used if omitted. ACCESS_MODE must be
one of: READ_ONLY_MANY, READ_WRITE_MANY, READ_WRITE_SINGLE. \fIACCESS_MODE\fR
must be one of:

.RS 2m
.TP 2m
\fBREAD_ONLY_MANY\fR
The AccessMode means the disk can be attached to multiple instances in RW mode.
.TP 2m
\fBREAD_WRITE_MANY\fR
The AccessMode means the disk can be attached to multiple instances in RO mode.
.TP 2m
\fBREAD_WRITE_SINGLE\fR
The default AccessMode, means the disk can be attached to single instance in RW
mode.
.RE
.sp


.TP 2m
\fB\-\-architecture\fR=\fIARCHITECTURE\fR

Specifies the architecture or processor type that this disk can support. For
available processor types on Compute Engine, see
https://cloud.google.com/compute/docs/cpu\-platforms. ARCHITECTURE must be one
of: ARM64, X86_64. \fIARCHITECTURE\fR must be one of:

.RS 2m
.TP 2m
\fBARM64\fR
The disk can only be used with ARM64 machines.
.TP 2m
\fBX86_64\fR
The disk can only be used with x86_64 machines.
.RE
.sp


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

Return immediately, without waiting for the operation in progress to complete.
The default is \fBTrue\fR. Enabled by default, use \fB\-\-no\-async\fR to
disable.

.TP 2m
\fB\-\-confidential\-compute\fR

Creates the disk with confidential compute mode enabled. Encryption with a Cloud
KMS key is required to enable this option.

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

Specifies a textual description of the restored disk.

.TP 2m
\fB\-\-guest\-os\-features\fR=[\fIGUEST_OS_FEATURES\fR,...]

Enables one or more features for VM instances that use the image for their boot
disks. See the descriptions of supported features at:
https://cloud.google.com/compute/docs/images/create\-delete\-deprecate\-private\-images#guest\-os\-features.
GUEST_OS_FEATURE must be one of: VIRTIO_SCSI_MULTIQUEUE, WINDOWS,
MULTI_IP_SUBNET, UEFI_COMPATIBLE, SEV_CAPABLE, SEV_LIVE_MIGRATABLE,
SEV_LIVE_MIGRATABLE_V2, SEV_SNP_CAPABLE, GVNIC, IDPF, TDX_CAPABLE,
SUSPEND_RESUME_COMPATIBLE.

.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

The Cloud KMS (Key Management Service) cryptokey that will be used to protect
the disk Provide the full resource name of the cryptokey in the format:
projects/<project>/locations/<location>/keyRings/<key\-ring>/cryptoKeys/<key>

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

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\-),
underscores (\fI), lowercase characters, and numbers. Values must contain only
hyphens (\-), underscores (\fR), lowercase characters, and numbers.

.TP 2m
\fB\-\-licenses\fR=\fILICENSE\fR,[\fILICENSE\fR,...]

A list of URIs to license resources. The provided licenses will be added onto
the created disks to indicate the licensing and billing policies.

.TP 2m
\fB\-\-provisioned\-iops\fR=\fIPROVISIONED_IOPS\fR

Provisioned IOPS of disk to create. Only for use with disks of type pd\-extreme
and hyperdisk\-extreme.

.TP 2m
\fB\-\-provisioned\-throughput\fR=\fIPROVISIONED_THROUGHPUT\fR

Provisioned throughput of disk to create. The throughput unit is MB per sec.
Only for use with disks of type hyperdisk\-throughput.

.TP 2m
\fB\-\-replica\-zones\fR=\fIZONE\fR,\fIZONE\fR

A comma\-separated list of exactly 2 URLs of the zones where the disk should be
replicated to. Required when restoring to a regional disk. The zones must be in
the same region as specified in the \-\-target\-region flag. See available zones
with gcloud compute zones list.

.TP 2m
\fB\-\-resource\-policies\fR=\fIRESOURCE_POLICY\fR,[...]

A list of resource policy names to be added to the disk. The policies must exist
in the same region as the disk.

.TP 2m
\fB\-\-size\fR=\fISIZE\fR

Size of the disk in GB. Disk size must be a multiple of 1 GB. If disk size is
not specified, the default size of 500GB for pd\-standard disks, 100GB for
pd\-balanced disks, 100GB for pd\-ssd disks, and 1000GB for pd\-extreme disks
will be used. For details about disk size limits, refer to:
https://cloud.google.com/compute/docs/disks

.TP 2m
\fB\-\-storage\-pool\fR=\fISTORAGE_POOL\fR

Specifies the URI of the storage pool in which the disk is created.

.TP 2m
\fB\-\-target\-region\fR=\fITARGET_REGION\fR

Region where the target disk is restored. This flag is mutually exclusive with
\-\-target\-zone.

.TP 2m
\fB\-\-target\-zone\fR=\fITARGET_ZONE\fR

Zone where the target disk is restored. This flag is mutually exclusive with
\-\-target\-region.

.TP 2m
\fB\-\-type\fR=\fITYPE\fR

URL of the disk type describing which disk type to use to restore the disk. For
example: projects/project/zones/zone/diskTypes/pd\-ssd. To get a list of
available disk types, run gcloud compute disk\-types list. The default disk type
is pd\-standard.


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

Restores the specified backup



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha backup\-dr backups restore disk
.RE