Bulk restore specifications

Based on the bulk restore options you specify when restoring multiple instances or disks belonging to multiple instances, R‑Cloud generates a bulk restore specification.

Elements of a bulk restore specification

The basic elements of a bulk restore specification include the type of the bulk restore specification (bulkRestoreType), a flag whether to overwrite existing items (overwriteExisting), and the items to restore.

Syntax

{
  "bulkRestoreType": "VMS" | "DISKS",
  "overwriteExisting": false | true,
  "items": [
    {
      "source":
      {
        "path": "<path>",
        "disks": [<disk>,...]
      },
      "destination":
      {
        "path": "<path>",
        "disks": [<disk>, ...],
        "networkInterfaces": [<networkInterface>, ...],
        "metadata": {},
        "labels": {},
        "tags": []
      },
    },
    ...
  ],
}

Basic elements

bulkRestoreType: "VMS" | "DISKS"

The bulk restore type, VMS for instances and DISKS for disks.
overwriteExisting: false | true

If set to true, instances in the destination region and zone with the same name as the source instances or disks attached to instances, with the same name as the source disks are overwritten during restore.

Default: false
items []

An array of items to restore, each item element contains a source and a destination.

Items to restore

Each item consists of a source and a destination record:

source

The source record contains the path and an array listing the disks.
destination

The destination record contains the path, an array listing the disks, an array listing the network interfaces, and tags and labels.

Source and destination elements

path

The path in the format projects/<Project>/zones/<TargetZone>/instance/<InstanceName>.
disks

An array containing the disks to be restored. Disks can either contain the disk name for the source disks or a record with the following elements in the case of destination disks:
- sourceType
  
  The source type of the original disk: AWS for AWS, AZURE for Azure, or GC for Google Cloud.
- diskName
  
  The name of the original disk.
- newDiskName
  
  The name of the restored disk, including the specified postfix. If no postfix is specified, the new name equals the original disk name.
- newDeviceName
  
  The name of the restored disk device, including the specified postfix. If no postfix is specified, the new name equals the original device name.
- diskType
  
  One of the available disk types for the restored disk:
  - For AWS, this is IO2 or IO1 for provisioned IOPS SSD disks, GP3 or GP2 for general purpose SSD disks, SC1 for cold HDD disks, and ST1 for throughput optimized HDD disks.
  - For Google Cloud, this is BALANCED for balanced persistent disks, EXTREME for extreme persistent disks, HDD for standard persistent disks, or SSD for SSD persistent disks.
  By default, the original disk type is used. For Azure, the default disk type is the only available type.
- region
  
  Specifies the region. You can use it to define a different destination region for the disk.
- replicaZones
  
  An array listing the replica zones.
  
  For regional disks, by default only the same replica zone as in the path is added. You need to add the second zone.
networkInterfaces

An array containing network interfaces. Each interface is a record with the following elements:
- sourceType
  
  The source type of the network interface: AWS for AWS, AZURE for Azure, or GC for Google Cloud.
- path
  
  The path to the network device.
- publicIpType
  
  The public IP type for the network interface:
  - For AWS, the AUTO_ASSIGN option is always selected.
  - For Azure, you can select among the following options:
    - NONE
    - STATIC
    - EXISTING
  - For Google Cloud, you can select among the following options:
    - NONE
    - EPHEMERAL
    - STATIC_RESERVED
    - STATIC_NEW
- publicIp
  
  The public IP value, if supported by the public IP type.
- privatelIpType
  
  The private IP address type for the network interface:
  - For AWS, the AUTO_ASSIGN option is always selected.
  - For Azure, you can select between the following options:
    - DYNAMIC
    - STATIC
  - For Google Cloud, you can select among the following options:
    - EPHEMERAL_AUTOMATIC
    - EPHEMERAL_CUSTOM
    - STATIC_RESERVED
    - STATIC_NEW
- privateIp
  
  The private IP value, if supported by the private IP type.
The interfaces are selected in the following order:
1. A legacy network with same name.
2. Shared subnetworks that are accessible in destination projects.
3. A subnetwork with the name "default".
4. The first subnetwork in the specified region (sorted by name alphabetically).
Labels, metadata, and tags
- metadata
  
  Custom metadata tags, consisting of a key and a value pair.
- labels
  
  Labels for the restored disk, consisting of a key and a value pair.
- tags
  
  An array of tags (strings).
For AWS: Operating system image AMI ID
- imageId
  
  AMI ID of the custom operating system image.