Create an instance with additional non-boot disks


When you create a compute instance, you can create and attach additional non-boot disks to the instance at the same time. You can also choose existing disks to attach as non-boot disks .

If you want to create a disk in multi-writer mode, you can't create the disk at the same time that you create the instance. You must create the disk first, then you can attach the disk to the instance.

Before you begin

  • If you haven't already, set up authentication . Authentication verifies your identity for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate to Compute Engine by selecting one of the following options:

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:

      gcloud  
      init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

    2. Set a default region and zone .

    REST

    To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

      Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:

      gcloud  
      init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

    For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

Required roles

To get the permissions that you need to create an instance with added non-boot disks, ask your administrator to grant you the Compute Instance Admin (v1) ( roles/compute.instanceAdmin.v1 ) IAM role on the project. For more information about granting roles, see Manage access to projects, folders, and organizations .

This predefined role contains the permissions required to create an instance with added non-boot disks. To see the exact permissions that are required, expand the Required permissionssection:

Required permissions

The following permissions are required to create an instance with added non-boot disks:

  • compute.instances.create on the project
  • To create a new disk for the instance: compute.disks.create on the project

You might also be able to get these permissions with custom roles or other predefined roles .

Create an instance with new additional non-boot disks

To create an instance that has additional non-boot disks created and attached, follow these steps:

Console

  1. In the Google Cloud console, go to the Create an instancepage.

    Go to Create an instance

    If prompted, select your project and click Continue.

    The Create an instancepage appears and displays the Machine configurationpane.

  2. In the Machine configurationpane, do the following:

    1. In the Namefield, specify a name for your instance. For more information, see Resource naming convention .
    2. Optional: In the Zonefield, select a zone for this instance.

      The default selection is Any. If you don't change this default selection, then Google automatically chooses a zone for you based on machine type and availability.

    3. Select the machine family for your instance. The Google Cloud console then displays the machine series that are available for your selected machine family. The following machine family options are available:

      • General purpose
      • Compute optimized
      • Memory optimized
      • Storage optimized
      • GPUs
    4. In the Seriescolumn, select the machine series for your instance.

      If you selected GPUsas the machine family in the previous step, then select the GPU typethat you want. The machine series is then automatically selected for the selected GPU type.

    5. In the Machine typesection, select the machine type for your instance.

  3. In the navigation menu, click OS and storage. In the Operating system and storagepane that appears, complete the following steps.

    To learn more about the parameters that you can configure while adding new disks, see About Persistent Disk and About Google Cloud Hyperdisk .

    1. To configure your boot disk, click Change. The Boot diskpane appears and displays the Public imagestab.

    2. Configure the data source for the boot disk in one of the following ways:

      • To choose a public image as the data source for your boot disk, in the Public imagestab, specify the following:

        1. In the Operating systemlist, select the OS type.
        2. In the Versionlist, select the OS version.
        3. In the Boot disk typelist, select the type of the boot disk.
        4. In the Size (GB)field, specify the size of the boot disk.
      • To choose a custom image as the data source for your boot disk, click Custom imagesand then, in the Custom imagestab that appears, specify the following:

        1. To select the image project, click Change, and then select the project that contains the image.
        2. In the Imagelist, select the image that you want to import.
        3. In the Boot disk typelist, select the type of the boot disk.
        4. In the Size (GB)field, specify the size of the boot disk.
      • To choose a standard snapshot as the data source for your boot disk, click Snapshotsand then, in the Snapshotstab that appears, specify the following:

        1. In the Snapshotlist, select the snapshot.
        2. In the Boot disk typelist, select the type of the boot disk.
        3. In the Size (GB)field, specify the size of the boot disk.
      • To choose an archive snapshot as the data source for your boot disk, click Archive snapshotsand then, in the Archive snapshotstab that appears, specify the following:

        1. In the Archive snapshotlist, select the archive snapshot.
        2. In the Boot disk typelist, select the type of the boot disk.
        3. In the Size (GB)field, specify the size of the boot disk.
      • To choose an existing disk as your boot disk, click Existing disks. Then, in the Existing diskstab that appears, select an existing regional Persistent Disk or Hyperdisk Balanced High Availability volume in the Disklist.

    3. Optional: For advanced configuration options, expand the Show advanced configurationssection.

    4. To confirm your boot disk options and return to the Operating system and storagepane, click Select.

    5. To create a new non-boot disk and attach it to your instance, in the Additional storage and VM backupssection, click Add new disk.

      In the Add new diskpane that appears, do the following:

      1. In the Namefield, specify a name for the non-boot disk.
      2. In the Disk source typelist, select the source type for the non-boot disk.
      3. In the Disk typelist, select a type for the non-boot disk.
      4. In the Sizefield, specify the size of the non-boot disk.
      5. In the Attachment settingssection, do the following:
      6. In the Modefield, select the disk attachment mode.
      7. In the Deletion rulefiled, select an option to specify what happens to the disk when the instance is deleted.

      Repeat this step for each non-boot disk that you want to create and attach to your instance.

  4. In the navigation menu, click Data protection. In the Data protectionpane that appears, specify how you want to back up and replicate the data for your instance by doing the following.

    1. To specify how you want to back up data, select an option for Back up your data.
    2. To specify how you want to replicate data, do the following:

      1. If you want new disks for the instance to be synchronously replicated in a second zone by using regional disks types , select the Regional diskscheckbox.
      1. If you want disks for the instance to be replicated in a second region using Persistent Disk Asynchronous Replication , select the Asynchronous replicationcheckbox.
    3. If you only want to use the specified data protection options on non-boot disks, select the Exclude boot diskscheckbox.

  5. In the navigation menu, click Networking. In the Networkingpane that appears, do the following:

    1. Go to the Firewallsection.
    2. To permit HTTP or HTTPS traffic to the instance, select Allow HTTP trafficor Allow HTTPS traffic.

      The Compute Engine adds a network tag to your instance and creates the corresponding ingress firewall rule that allows all incoming traffic on tcp:80 (HTTP) or tcp:443 (HTTPS). The network tag associates the firewall rule with the instance. For more information, see Firewall rules overview in the Cloud Next Generation Firewall documentation.

  6. Optional: Specify other configuration options. For more information, see Configuration options during instance creation .

  7. To create and start the instance, click Create.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Run the gcloud compute instances create command to create an instance with additional non-boot disks.

    You can add up to 127 non-boot disks while you're creating your instance. Specify the --create-disk flag for each non-boot disk you create.

    To create non-boot disks from a public or stock image, specify the image or image-family and image-project properties with the --create-disk flag. To create a blank disk, don't include these properties.

    You can optionally include properties for:

    • Disk size: use the --size property.
    • Disk type: use the --type property.
    • Regional disks: include the replica-zones property.
    gcloud compute instances create INSTANCE_NAME 
    \
        --zone= ZONE 
    \
        --image-project= IMAGE_PROJECT 
    \ IMAGE_FLAG 
    \
        --create-disk DISK_IMAGE 
    ,image-project= DISK_IMAGE_PROJECT 
    ,size= SIZE_GB 
    ,type= DISK_TYPE 
    \
        --create-disk device-name= DISK_NAME 
    ,replica-zones=^:^ ZONE 
    : REMOTE-ZONE 
    ,boot=false

    Replace the following:

    • INSTANCE_NAME : name of the new instance
    • ZONE : zone to create the instance in
    • IMAGE_PROJECT : project containing the image
    • IMAGE_FLAG : specify one of the following:

      • Use the --image IMAGE_NAME flag to specify a specific version of a public or custom image. For example, --image debian-12-bookworm-v20241112 .

      • Use the --image-family IMAGE_FAMILY_NAME flag to specify an image family . This creates the instance that uses the most recent, non-deprecated OS image in the image family. For example, if you specify --image-family debian-12 , then Compute Engine uses the latest version of the OS image in the Debian 12 image family when creating the instance.

    • For additional disks, replace the following:

      • DISK_IMAGE : Specify one of the following:
        • image= DISK_IMAGE_NAME : name of the image that you want to use when creating a non-boot disk
        • image-family= DISK_IMAGE_FAMILY >: an image family to use when creating a non-boot disk
      • DISK_IMAGE_PROJECT : an image project to which the disk image belongs
      • SIZE_GB : Optional: size of the non-boot disk
      • DISK_TYPE : Optional: full or partial URL for the type of the disk

        For example, https://www.googleapis.com/compute/v1/projects/ PROJECT_ID /zones/ ZONE /diskTypes/hyperdisk-balanced . To view the available disk types in one or more zones, use the gcloud compute disk-types list --zones= ZONE_LIST command . Replace ZONE_LIST with a comma-separated list of zones.

      • DISK_NAME : Optional: the disk name displayed to the guest OS after the instance is created.

      • REMOTE_ZONE : the zone where the disk should be replicated to

      For blank disks, don't specify the image , image-project , or image-family parameters.

      For zonal disks, don't specify the disk property replica-zones .

Terraform

To generate the Terraform code, you can use the Equivalent codecomponent in the Google Cloud console.
  1. In the Google Cloud console, go to the VM instancespage.

    Go to VM Instances

  2. Click Create instance.
  3. Specify the parameters you want.
  4. At the top or bottom of the page, click Equivalent code, and then click the Terraformtab to view the Terraform code.

Go

Before trying this sample, follow the Go setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Go API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 computepb 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
  
 "google.golang.org/protobuf/proto" 
 ) 
 // createWithAdditionalDisk create a new VM instance with Debian 10 operating system and a 11 GB additional empty disk. 
 func 
  
 createWithAdditionalDisk 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 zone 
 , 
  
 instanceName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // zone := "europe-central2-b" 
  
 // instanceName := "your_instance_name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 instancesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewInstancesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewInstancesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 instancesClient 
 . 
 Close 
 () 
  
 imagesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewImagesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewImagesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 imagesClient 
 . 
 Close 
 () 
  
 // List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details. 
  
 newestDebianReq 
  
 := 
  
& computepb 
 . 
 GetFromFamilyImageRequest 
 { 
  
 Project 
 : 
  
 "debian-cloud" 
 , 
  
 Family 
 : 
  
 "debian-12" 
 , 
  
 } 
  
 newestDebian 
 , 
  
 err 
  
 := 
  
 imagesClient 
 . 
  GetFromFamily 
 
 ( 
 ctx 
 , 
  
 newestDebianReq 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to get image from family: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 req 
  
 := 
  
& computepb 
 . 
 InsertInstanceRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Zone 
 : 
  
 zone 
 , 
  
 InstanceResource 
 : 
  
& computepb 
 . 
 Instance 
 { 
  
 Name 
 : 
  
 proto 
 . 
 String 
 ( 
 instanceName 
 ), 
  
 Disks 
 : 
  
 [] 
 * 
 computepb 
 . 
 AttachedDisk 
 { 
  
 { 
  
 InitializeParams 
 : 
  
& computepb 
 . 
 AttachedDiskInitializeParams 
 { 
  
 DiskSizeGb 
 : 
  
 proto 
 . 
 Int64 
 ( 
 10 
 ), 
  
 SourceImage 
 : 
  
 newestDebian 
 . 
 SelfLink 
 , 
  
 DiskType 
 : 
  
 proto 
 . 
 String 
 ( 
 fmt 
 . 
 Sprintf 
 ( 
 "zones/%s/diskTypes/pd-standard" 
 , 
  
 zone 
 )), 
  
 }, 
  
 AutoDelete 
 : 
  
 proto 
 . 
 Bool 
 ( 
 true 
 ), 
  
 Boot 
 : 
  
 proto 
 . 
 Bool 
 ( 
 true 
 ), 
  
 Type 
 : 
  
 proto 
 . 
 String 
 ( 
 computepb 
 . 
  AttachedDisk_PERSISTENT 
 
 . 
 String 
 ()), 
  
 }, 
  
 { 
  
 InitializeParams 
 : 
  
& computepb 
 . 
 AttachedDiskInitializeParams 
 { 
  
 DiskSizeGb 
 : 
  
 proto 
 . 
 Int64 
 ( 
 11 
 ), 
  
 DiskType 
 : 
  
 proto 
 . 
 String 
 ( 
 fmt 
 . 
 Sprintf 
 ( 
 "zones/%s/diskTypes/pd-standard" 
 , 
  
 zone 
 )), 
  
 }, 
  
 AutoDelete 
 : 
  
 proto 
 . 
 Bool 
 ( 
 true 
 ), 
  
 Boot 
 : 
  
 proto 
 . 
 Bool 
 ( 
 false 
 ), 
  
 Type 
 : 
  
 proto 
 . 
 String 
 ( 
 computepb 
 . 
  AttachedDisk_PERSISTENT 
 
 . 
 String 
 ()), 
  
 }, 
  
 }, 
  
 MachineType 
 : 
  
 proto 
 . 
 String 
 ( 
 fmt 
 . 
 Sprintf 
 ( 
 "zones/%s/machineTypes/n1-standard-1" 
 , 
  
 zone 
 )), 
  
 NetworkInterfaces 
 : 
  
 [] 
 * 
 computepb 
 . 
 NetworkInterface 
 { 
  
 { 
  
 Name 
 : 
  
 proto 
 . 
 String 
 ( 
 "global/networks/default" 
 ), 
  
 }, 
  
 }, 
  
 }, 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 instancesClient 
 . 
 Insert 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to create instance: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 if 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to wait for the operation: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Instance created\n" 
 ) 
  
 return 
  
 nil 
 } 
 

Java

Before trying this sample, follow the Java setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Java API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.api.gax.longrunning. OperationFuture 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. AttachedDisk 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. AttachedDisk 
.Type 
 ; 
 import 
  
 com.google.cloud.compute.v1. AttachedDiskInitializeParams 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Image 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. ImagesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InsertInstanceRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Instance 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InstancesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. NetworkInterface 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Operation 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.Vector 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 CreateInstancesAdvanced 
  
 { 
  
 /** 
 * Create an AttachedDisk object to be used in VM instance creation. Uses an image as the source 
 * for the new disk. 
 * 
 * @param diskType the type of disk you want to create. This value uses the following format: 
 * "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example: 
 * "zones/us-west3-b/diskTypes/pd-ssd" 
 * @param diskSizeGb size of the new disk in gigabytes 
 * @param boot boolean flag indicating whether this disk should be used as a boot disk of an 
 * instance 
 * @param sourceImage source image to use when creating this disk. You must have read access to 
 * this disk. This can be one of the publicly available images or an image from one of your 
 * projects. This value uses the following format: 
 * "projects/{project_name}/global/images/{image_name}" 
 * @return AttachedDisk object configured to be created using the specified image. 
 */ 
  
 private 
  
 static 
  
  AttachedDisk 
 
  
 diskFromImage 
 ( 
 String 
  
 diskType 
 , 
  
 int 
  
 diskSizeGb 
 , 
  
 boolean 
  
 boot 
 , 
  
 String 
  
 sourceImage 
 ) 
  
 { 
  
  AttachedDisk 
 
  
 disk 
  
 = 
  
  AttachedDisk 
 
 . 
 newBuilder 
 () 
  
 . 
 setBoot 
 ( 
 boot 
 ) 
  
 // Remember to set auto_delete to True if you want the disk to be deleted when 
  
 // you delete your VM instance. 
  
 . 
 setAutoDelete 
 ( 
 true 
 ) 
  
 . 
 setType 
 ( 
 Type 
 . 
 PERSISTENT 
 . 
 toString 
 ()) 
  
 . 
  setInitializeParams 
 
 ( 
  
  AttachedDiskInitializeParams 
 
 . 
 newBuilder 
 () 
  
 . 
 setSourceImage 
 ( 
 sourceImage 
 ) 
  
 . 
 setDiskSizeGb 
 ( 
 diskSizeGb 
 ) 
  
 . 
 setDiskType 
 ( 
 diskType 
 ) 
  
 . 
 build 
 ()) 
  
 . 
 build 
 (); 
  
 return 
  
 disk 
 ; 
  
 } 
  
 /** 
 * Create an AttachedDisk object to be used in VM instance creation. The created disk contains no 
 * data and requires formatting before it can be used. 
 * 
 * @param diskType the type of disk you want to create. This value uses the following format: 
 * "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". For example: 
 * "zones/us-west3-b/diskTypes/pd-ssd" 
 * @param diskSizeGb size of the new disk in gigabytes 
 * @return AttachedDisk object configured to be created as an empty disk. 
 */ 
  
 private 
  
 static 
  
  AttachedDisk 
 
  
 emptyDisk 
 ( 
 String 
  
 diskType 
 , 
  
 int 
  
 diskSizeGb 
 ) 
  
 { 
  
  AttachedDisk 
 
  
 disk 
  
 = 
  
  AttachedDisk 
 
 . 
 newBuilder 
 () 
  
 . 
 setBoot 
 ( 
 false 
 ) 
  
 // Remember to set auto_delete to True if you want the disk to be deleted when 
  
 // you delete your VM instance. 
  
 . 
 setAutoDelete 
 ( 
 true 
 ) 
  
 . 
 setType 
 ( 
 Type 
 . 
 PERSISTENT 
 . 
 toString 
 ()) 
  
 . 
  setInitializeParams 
 
 ( 
  
  AttachedDiskInitializeParams 
 
 . 
 newBuilder 
 () 
  
 . 
 setDiskSizeGb 
 ( 
 diskSizeGb 
 ) 
  
 . 
 setDiskType 
 ( 
 diskType 
 ) 
  
 . 
 build 
 ()) 
  
 . 
 build 
 (); 
  
 return 
  
 disk 
 ; 
  
 } 
  
 /** 
 * Send an instance creation request to the Compute Engine API and wait for it to complete. 
 * 
 * @param project project ID or project number of the Cloud project you want to use. 
 * @param zone name of the zone to create the instance in. For example: "us-west3-b" 
 * @param instanceName name of the new virtual machine (VM) instance. 
 * @param disks a list of compute_v1.AttachedDisk objects describing the disks you want to attach 
 * to your new instance. 
 * @param machineType machine type of the VM being created. This value uses the following format: 
 * "zones/{zone}/machineTypes/{type_name}". 
 * For example: "zones/europe-west3-c/machineTypes/f1-micro" 
 * @param network name of the network you want the new instance to use. For example: 
 * "global/networks/default" represents the network named "default", which is created 
 * automatically for each project. 
 * @param subnetwork name of the subnetwork you want the new instance to use. This value uses the 
 * following format: "regions/{region}/subnetworks/{subnetwork_name}" 
 * @return Instance object. 
 */ 
  
 private 
  
 static 
  
  Instance 
 
  
 createWithDisks 
 ( 
 String 
  
 project 
 , 
  
 String 
  
 zone 
 , 
  
 String 
  
 instanceName 
 , 
  
 Vector<AttachedDisk> 
  
 disks 
 , 
  
 String 
  
 machineType 
 , 
  
 String 
  
 network 
 , 
  
 String 
  
 subnetwork 
 ) 
  
 throws 
  
 IOException 
 , 
  
 InterruptedException 
 , 
  
 ExecutionException 
 , 
  
 TimeoutException 
  
 { 
  
 try 
  
 ( 
  InstancesClient 
 
  
 instancesClient 
  
 = 
  
  InstancesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // Use the network interface provided in the networkName argument. 
  
  NetworkInterface 
 
  
 networkInterface 
 ; 
  
 if 
  
 ( 
 subnetwork 
  
 != 
  
 null 
 ) 
  
 { 
  
 networkInterface 
  
 = 
  
  NetworkInterface 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 network 
 ). 
 setSubnetwork 
 ( 
 subnetwork 
 ) 
  
 . 
 build 
 (); 
  
 } 
  
 else 
  
 { 
  
 networkInterface 
  
 = 
  
  NetworkInterface 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 network 
 ). 
 build 
 (); 
  
 } 
  
 machineType 
  
 = 
  
 String 
 . 
 format 
 ( 
 "zones/%s/machineTypes/%s" 
 , 
  
 zone 
 , 
  
 machineType 
 ); 
  
 // Bind `instanceName`, `machineType`, `disk`, and `networkInterface` to an instance. 
  
  Instance 
 
  
 instanceResource 
  
 = 
  
  Instance 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 instanceName 
 ) 
  
 . 
 setMachineType 
 ( 
 machineType 
 ) 
  
 . 
 addAllDisks 
 ( 
 disks 
 ) 
  
 . 
 addNetworkInterfaces 
 ( 
 networkInterface 
 ) 
  
 . 
 build 
 (); 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Creating instance: %s at %s " 
 , 
  
 instanceName 
 , 
  
 zone 
 ); 
  
 // Insert the instance in the specified project and zone. 
  
  InsertInstanceRequest 
 
  
 insertInstanceRequest 
  
 = 
  
  InsertInstanceRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 project 
 ) 
  
 . 
 setZone 
 ( 
 zone 
 ) 
  
 . 
 setInstanceResource 
 ( 
 instanceResource 
 ). 
 build 
 (); 
  
 OperationFuture<Operation 
 , 
  
 Operation 
>  
 operation 
  
 = 
  
 instancesClient 
 . 
 insertAsync 
 ( 
  
 insertInstanceRequest 
 ); 
  
 // Wait for the operation to complete. 
  
  Operation 
 
  
 response 
  
 = 
  
 operation 
 . 
 get 
 ( 
 3 
 , 
  
 TimeUnit 
 . 
 MINUTES 
 ); 
  
 if 
  
 ( 
 response 
 . 
  hasError 
 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Instance creation failed ! ! " 
  
 + 
  
 response 
 ); 
  
 return 
  
 null 
 ; 
  
 } 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Operation Status: " 
  
 + 
  
 response 
 . 
  getStatus 
 
 ()); 
  
 return 
  
 instancesClient 
 . 
 get 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 ); 
  
 } 
  
 } 
  
 /** 
 * Create a new VM instance with Debian 11 operating system and a 11 GB additional empty disk. 
 * 
 * @param project project ID or project number of the Cloud project you want to use. 
 * @param zone name of the zone to create the instance in. For example: "us-west3-b" 
 * @param instanceName name of the new virtual machine (VM) instance. 
 * @return Instance object. 
 */ 
  
 public 
  
 static 
  
  Instance 
 
  
 createWithAdditionalDisk 
 ( 
 String 
  
 project 
 , 
  
 String 
  
 zone 
 , 
  
 String 
  
 instanceName 
 ) 
  
 throws 
  
 IOException 
 , 
  
 InterruptedException 
 , 
  
 ExecutionException 
 , 
  
 TimeoutException 
  
 { 
  
 try 
  
 ( 
  ImagesClient 
 
  
 imagesClient 
  
 = 
  
  ImagesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details 
  
  Image 
 
  
 image 
  
 = 
  
 imagesClient 
 . 
  getFromFamily 
 
 ( 
 "debian-cloud" 
 , 
  
 "debian-11" 
 ); 
  
 String 
  
 diskType 
  
 = 
  
 String 
 . 
 format 
 ( 
 "zones/%s/diskTypes/pd-standard" 
 , 
  
 zone 
 ); 
  
 Vector<AttachedDisk> 
  
 disks 
  
 = 
  
 new 
  
 Vector 
<> (); 
  
 disks 
 . 
 add 
 ( 
 diskFromImage 
 ( 
 diskType 
 , 
  
 10 
 , 
  
 true 
 , 
  
 image 
 . 
  getSelfLink 
 
 ())); 
  
 disks 
 . 
 add 
 ( 
 emptyDisk 
 ( 
 diskType 
 , 
  
 11 
 )); 
  
 return 
  
 createWithDisks 
 ( 
 project 
 , 
  
 zone 
 , 
  
 instanceName 
 , 
  
 disks 
 , 
  
 "n1-standard-1" 
 , 
  
 "global/networks/default" 
 , 
  
 null 
 ); 
  
 } 
  
 } 
 

Node.js

Before trying this sample, follow the Node.js setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Node.js API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  /** 
 * TODO(developer): Uncomment and replace these variables before running the sample. 
 */ 
 // const projectId = 'YOUR_PROJECT_ID'; 
 // const zone = 'europe-central2-b'; 
 // const instanceName = 'YOUR_INSTANCE_NAME'; 
 const 
  
 compute 
  
 = 
  
 require 
 ( 
 ' @google-cloud/compute 
' 
 ); 
 // Create a new VM instance with Debian 10 operating system and a 11 GB additional empty disk. 
 async 
  
 function 
  
 createWithAdditionalDisk 
 () 
  
 { 
  
 const 
  
 instancesClient 
  
 = 
  
 new 
  
 compute 
 . 
  InstancesClient 
 
 (); 
  
 const 
  
 imagesClient 
  
 = 
  
 new 
  
 compute 
 . 
  ImagesClient 
 
 (); 
  
 // List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details. 
  
 const 
  
 [ 
 newestDebian 
 ] 
  
 = 
  
 await 
  
 imagesClient 
 . 
 getFromFamily 
 ({ 
  
 project 
 : 
  
 'debian-cloud' 
 , 
  
 family 
 : 
  
 'debian-11' 
 , 
  
 }); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 instancesClient 
 . 
 insert 
 ({ 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 , 
  
 instanceResource 
 : 
  
 { 
  
 name 
 : 
  
 instanceName 
 , 
  
 disks 
 : 
  
 [ 
  
 { 
  
 initializeParams 
 : 
  
 { 
  
 diskSizeGb 
 : 
  
 '10' 
 , 
  
 sourceImage 
 : 
  
 newestDebian 
 . 
 selfLink 
 , 
  
 diskType 
 : 
  
 `zones/ 
 ${ 
 zone 
 } 
 /diskTypes/pd-standard` 
 , 
  
 }, 
  
 autoDelete 
 : 
  
 true 
 , 
  
 boot 
 : 
  
 true 
 , 
  
 type 
 : 
  
 'PERSISTENT' 
 , 
  
 }, 
  
 { 
  
 initializeParams 
 : 
  
 { 
  
 diskSizeGb 
 : 
  
 '11' 
 , 
  
 diskType 
 : 
  
 `zones/ 
 ${ 
 zone 
 } 
 /diskTypes/pd-standard` 
 , 
  
 }, 
  
 autoDelete 
 : 
  
 true 
 , 
  
 boot 
 : 
  
 false 
 , 
  
 type 
 : 
  
 'PERSISTENT' 
 , 
  
 }, 
  
 ], 
  
 machineType 
 : 
  
 `zones/ 
 ${ 
 zone 
 } 
 /machineTypes/n1-standard-1` 
 , 
  
 networkInterfaces 
 : 
  
 [ 
  
 { 
  
 name 
 : 
  
 'global/networks/default' 
 , 
  
 }, 
  
 ], 
  
 }, 
  
 }); 
  
 let 
  
 operation 
  
 = 
  
 response 
 . 
 latestResponse 
 ; 
  
 const 
  
 operationsClient 
  
 = 
  
 new 
  
 compute 
 . 
  ZoneOperationsClient 
 
 (); 
  
 // Wait for the create operation to complete. 
  
 while 
  
 ( 
 operation 
 . 
 status 
  
 !== 
  
 'DONE' 
 ) 
  
 { 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 operationsClient 
 . 
 wait 
 ({ 
  
 operation 
 : 
  
 operation 
 . 
 name 
 , 
  
 project 
 : 
  
 projectId 
 , 
  
 zone 
 : 
  
 operation 
 . 
 zone 
 . 
 split 
 ( 
 '/' 
 ). 
 pop 
 (), 
  
 }); 
  
 } 
  
 console 
 . 
 log 
 ( 
 'Instance created.' 
 ); 
 } 
 createWithAdditionalDisk 
 (); 
 

Python

Before trying this sample, follow the Python setup instructions in the Compute Engine quickstart using client libraries . For more information, see the Compute Engine Python API reference documentation .

To authenticate to Compute Engine, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  from 
  
 __future__ 
  
 import 
 annotations 
 import 
  
 re 
 import 
  
 sys 
 from 
  
 typing 
  
 import 
 Any 
 import 
  
 warnings 
 from 
  
 google.api_core.extended_operation 
  
 import 
 ExtendedOperation 
 from 
  
 google.cloud 
  
 import 
 compute_v1 
 def 
  
 get_image_from_family 
 ( 
 project 
 : 
 str 
 , 
 family 
 : 
 str 
 ) 
 - 
> compute_v1 
 . 
 Image 
 : 
  
 """ 
 Retrieve the newest image that is part of a given family in a project. 
 Args: 
 project: project ID or project number of the Cloud project you want to get image from. 
 family: name of the image family you want to get image from. 
 Returns: 
 An Image object. 
 """ 
 image_client 
 = 
 compute_v1 
 . 
 ImagesClient 
 () 
 # List of public operating system (OS) images: https://cloud.google.com/compute/docs/images/os-details 
 newest_image 
 = 
 image_client 
 . 
 get_from_family 
 ( 
 project 
 = 
 project 
 , 
 family 
 = 
 family 
 ) 
 return 
 newest_image 
 def 
  
 disk_from_image 
 ( 
 disk_type 
 : 
 str 
 , 
 disk_size_gb 
 : 
 int 
 , 
 boot 
 : 
 bool 
 , 
 source_image 
 : 
 str 
 , 
 auto_delete 
 : 
 bool 
 = 
 True 
 , 
 ) 
 - 
> compute_v1 
 . 
 AttachedDisk 
 : 
  
 """ 
 Create an AttachedDisk object to be used in VM instance creation. Uses an image as the 
 source for the new disk. 
 Args: 
 disk_type: the type of disk you want to create. This value uses the following format: 
 "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". 
 For example: "zones/us-west3-b/diskTypes/pd-ssd" 
 disk_size_gb: size of the new disk in gigabytes 
 boot: boolean flag indicating whether this disk should be used as a boot disk of an instance 
 source_image: source image to use when creating this disk. You must have read access to this disk. This can be one 
 of the publicly available images or an image from one of your projects. 
 This value uses the following format: "projects/{project_name}/global/images/{image_name}" 
 auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it 
 Returns: 
 AttachedDisk object configured to be created using the specified image. 
 """ 
 boot_disk 
 = 
 compute_v1 
 . 
 AttachedDisk 
 () 
 initialize_params 
 = 
 compute_v1 
 . 
 AttachedDiskInitializeParams 
 () 
 initialize_params 
 . 
 source_image 
 = 
 source_image 
 initialize_params 
 . 
 disk_size_gb 
 = 
 disk_size_gb 
 initialize_params 
 . 
 disk_type 
 = 
 disk_type 
 boot_disk 
 . 
 initialize_params 
 = 
 initialize_params 
 # Remember to set auto_delete to True if you want the disk to be deleted when you delete 
 # your VM instance. 
 boot_disk 
 . 
 auto_delete 
 = 
 auto_delete 
 boot_disk 
 . 
 boot 
 = 
 boot 
 return 
 boot_disk 
 def 
  
 empty_disk 
 ( 
 disk_type 
 : 
 str 
 , 
 disk_size_gb 
 : 
 int 
 , 
 boot 
 : 
 bool 
 = 
 False 
 , 
 auto_delete 
 : 
 bool 
 = 
 True 
 ) 
 - 
> compute_v1 
 . 
 AttachedDisk 
 (): 
  
 """ 
 Create an AttachedDisk object to be used in VM instance creation. The created disk contains 
 no data and requires formatting before it can be used. 
 Args: 
 disk_type: the type of disk you want to create. This value uses the following format: 
 "zones/{zone}/diskTypes/(pd-standard|pd-ssd|pd-balanced|pd-extreme)". 
 For example: "zones/us-west3-b/diskTypes/pd-ssd" 
 disk_size_gb: size of the new disk in gigabytes 
 boot: boolean flag indicating whether this disk should be used as a boot disk of an instance 
 auto_delete: boolean flag indicating whether this disk should be deleted with the VM that uses it 
 Returns: 
 AttachedDisk object configured to be created as an empty disk. 
 """ 
 disk 
 = 
 compute_v1 
 . 
 AttachedDisk 
 () 
 initialize_params 
 = 
 compute_v1 
 . 
 AttachedDiskInitializeParams 
 () 
 initialize_params 
 . 
 disk_type 
 = 
 disk_type 
 initialize_params 
 . 
 disk_size_gb 
 = 
 disk_size_gb 
 disk 
 . 
 initialize_params 
 = 
 initialize_params 
 # Remember to set auto_delete to True if you want the disk to be deleted when you delete 
 # your VM instance. 
 disk 
 . 
 auto_delete 
 = 
 auto_delete 
 disk 
 . 
 boot 
 = 
 boot 
 return 
 disk 
 def 
  
 wait_for_extended_operation 
 ( 
 operation 
 : 
 ExtendedOperation 
 , 
 verbose_name 
 : 
 str 
 = 
 "operation" 
 , 
 timeout 
 : 
 int 
 = 
 300 
 ) 
 - 
> Any 
 : 
  
 """ 
 Waits for the extended (long-running) operation to complete. 
 If the operation is successful, it will return its result. 
 If the operation ends with an error, an exception will be raised. 
 If there were any warnings during the execution of the operation 
 they will be printed to sys.stderr. 
 Args: 
 operation: a long-running operation you want to wait on. 
 verbose_name: (optional) a more verbose name of the operation, 
 used only during error and warning reporting. 
 timeout: how long (in seconds) to wait for operation to finish. 
 If None, wait indefinitely. 
 Returns: 
 Whatever the operation.result() returns. 
 Raises: 
 This method will raise the exception received from `operation.exception()` 
 or RuntimeError if there is no exception set, but there is an `error_code` 
 set for the `operation`. 
 In case of an operation taking longer than `timeout` seconds to complete, 
 a `concurrent.futures.TimeoutError` will be raised. 
 """ 
 result 
 = 
 operation 
 . 
 result 
 ( 
 timeout 
 = 
 timeout 
 ) 
 if 
 operation 
 . 
 error_code 
 : 
 print 
 ( 
 f 
 "Error during 
 { 
 verbose_name 
 } 
 : [Code: 
 { 
 operation 
 . 
 error_code 
 } 
 ]: 
 { 
 operation 
 . 
 error_message 
 } 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 , 
 ) 
 print 
 ( 
 f 
 "Operation ID: 
 { 
 operation 
 . 
 name 
 } 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 ) 
 raise 
 operation 
 . 
 exception 
 () 
 or 
 RuntimeError 
 ( 
 operation 
 . 
 error_message 
 ) 
 if 
 operation 
 . 
 warnings 
 : 
 print 
 ( 
 f 
 "Warnings during 
 { 
 verbose_name 
 } 
 : 
 \n 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 ) 
 for 
 warning 
 in 
 operation 
 . 
 warnings 
 : 
 print 
 ( 
 f 
 " - 
 { 
 warning 
 . 
 code 
 } 
 : 
 { 
 warning 
 . 
 message 
 } 
 " 
 , 
 file 
 = 
 sys 
 . 
 stderr 
 , 
 flush 
 = 
 True 
 ) 
 return 
 result 
 def 
  
 create_instance 
 ( 
 project_id 
 : 
 str 
 , 
 zone 
 : 
 str 
 , 
 instance_name 
 : 
 str 
 , 
 disks 
 : 
 list 
 [ 
 compute_v1 
 . 
 AttachedDisk 
 ], 
 machine_type 
 : 
 str 
 = 
 "n1-standard-1" 
 , 
 network_link 
 : 
 str 
 = 
 "global/networks/default" 
 , 
 subnetwork_link 
 : 
 str 
 = 
 None 
 , 
 internal_ip 
 : 
 str 
 = 
 None 
 , 
 external_access 
 : 
 bool 
 = 
 False 
 , 
 external_ipv4 
 : 
 str 
 = 
 None 
 , 
 accelerators 
 : 
 list 
 [ 
 compute_v1 
 . 
 AcceleratorConfig 
 ] 
 = 
 None 
 , 
 preemptible 
 : 
 bool 
 = 
 False 
 , 
 spot 
 : 
 bool 
 = 
 False 
 , 
 instance_termination_action 
 : 
 str 
 = 
 "STOP" 
 , 
 custom_hostname 
 : 
 str 
 = 
 None 
 , 
 delete_protection 
 : 
 bool 
 = 
 False 
 , 
 ) 
 - 
> compute_v1 
 . 
 Instance 
 : 
  
 """ 
 Send an instance creation request to the Compute Engine API and wait for it to complete. 
 Args: 
 project_id: project ID or project number of the Cloud project you want to use. 
 zone: name of the zone to create the instance in. For example: "us-west3-b" 
 instance_name: name of the new virtual machine (VM) instance. 
 disks: a list of compute_v1.AttachedDisk objects describing the disks 
 you want to attach to your new instance. 
 machine_type: machine type of the VM being created. This value uses the 
 following format: "zones/{zone}/machineTypes/{type_name}". 
 For example: "zones/europe-west3-c/machineTypes/f1-micro" 
 network_link: name of the network you want the new instance to use. 
 For example: "global/networks/default" represents the network 
 named "default", which is created automatically for each project. 
 subnetwork_link: name of the subnetwork you want the new instance to use. 
 This value uses the following format: 
 "regions/{region}/subnetworks/{subnetwork_name}" 
 internal_ip: internal IP address you want to assign to the new instance. 
 By default, a free address from the pool of available internal IP addresses of 
 used subnet will be used. 
 external_access: boolean flag indicating if the instance should have an external IPv4 
 address assigned. 
 external_ipv4: external IPv4 address to be assigned to this instance. If you specify 
 an external IP address, it must live in the same region as the zone of the instance. 
 This setting requires `external_access` to be set to True to work. 
 accelerators: a list of AcceleratorConfig objects describing the accelerators that will 
 be attached to the new instance. 
 preemptible: boolean value indicating if the new instance should be preemptible 
 or not. Preemptible VMs have been deprecated and you should now use Spot VMs. 
 spot: boolean value indicating if the new instance should be a Spot VM or not. 
 instance_termination_action: What action should be taken once a Spot VM is terminated. 
 Possible values: "STOP", "DELETE" 
 custom_hostname: Custom hostname of the new VM instance. 
 Custom hostnames must conform to RFC 1035 requirements for valid hostnames. 
 delete_protection: boolean value indicating if the new virtual machine should be 
 protected against deletion or not. 
 Returns: 
 Instance object. 
 """ 
 instance_client 
 = 
 compute_v1 
 . 
 InstancesClient 
 () 
 # Use the network interface provided in the network_link argument. 
 network_interface 
 = 
 compute_v1 
 . 
 NetworkInterface 
 () 
 network_interface 
 . 
 network 
 = 
 network_link 
 if 
 subnetwork_link 
 : 
 network_interface 
 . 
 subnetwork 
 = 
 subnetwork_link 
 if 
 internal_ip 
 : 
 network_interface 
 . 
 network_i_p 
 = 
 internal_ip 
 if 
 external_access 
 : 
 access 
 = 
 compute_v1 
 . 
 AccessConfig 
 () 
 access 
 . 
 type_ 
 = 
 compute_v1 
 . 
 AccessConfig 
 . 
 Type 
 . 
 ONE_TO_ONE_NAT 
 . 
 name 
 access 
 . 
 name 
 = 
 "External NAT" 
 access 
 . 
 network_tier 
 = 
 access 
 . 
 NetworkTier 
 . 
 PREMIUM 
 . 
 name 
 if 
 external_ipv4 
 : 
 access 
 . 
 nat_i_p 
 = 
 external_ipv4 
 network_interface 
 . 
 access_configs 
 = 
 [ 
 access 
 ] 
 # Collect information into the Instance object. 
 instance 
 = 
 compute_v1 
 . 
 Instance 
 () 
 instance 
 . 
 network_interfaces 
 = 
 [ 
 network_interface 
 ] 
 instance 
 . 
 name 
 = 
 instance_name 
 instance 
 . 
 disks 
 = 
 disks 
 if 
 re 
 . 
 match 
 ( 
 r 
 "^zones/[a-z\d\-]+/machineTypes/[a-z\d\-]+$" 
 , 
 machine_type 
 ): 
 instance 
 . 
 machine_type 
 = 
 machine_type 
 else 
 : 
 instance 
 . 
 machine_type 
 = 
 f 
 "zones/ 
 { 
 zone 
 } 
 /machineTypes/ 
 { 
 machine_type 
 } 
 " 
 instance 
 . 
 scheduling 
 = 
 compute_v1 
 . 
 Scheduling 
 () 
 if 
 accelerators 
 : 
 instance 
 . 
 guest_accelerators 
 = 
 accelerators 
 instance 
 . 
 scheduling 
 . 
 on_host_maintenance 
 = 
 ( 
 compute_v1 
 . 
 Scheduling 
 . 
 OnHostMaintenance 
 . 
 TERMINATE 
 . 
 name 
 ) 
 if 
 preemptible 
 : 
 # Set the preemptible setting 
 warnings 
 . 
 warn 
 ( 
 "Preemptible VMs are being replaced by Spot VMs." 
 , 
 DeprecationWarning 
 ) 
 instance 
 . 
 scheduling 
 = 
 compute_v1 
 . 
 Scheduling 
 () 
 instance 
 . 
 scheduling 
 . 
 preemptible 
 = 
 True 
 if 
 spot 
 : 
 # Set the Spot VM setting 
 instance 
 . 
 scheduling 
 . 
 provisioning_model 
 = 
 ( 
 compute_v1 
 . 
 Scheduling 
 . 
 ProvisioningModel 
 . 
 SPOT 
 . 
 name 
 ) 
 instance 
 . 
 scheduling 
 . 
 instance_termination_action 
 = 
 instance_termination_action 
 if 
 custom_hostname 
 is 
 not 
 None 
 : 
 # Set the custom hostname for the instance 
 instance 
 . 
 hostname 
 = 
 custom_hostname 
 if 
 delete_protection 
 : 
 # Set the delete protection bit 
 instance 
 . 
 deletion_protection 
 = 
 True 
 # Prepare the request to insert an instance. 
 request 
 = 
 compute_v1 
 . 
 InsertInstanceRequest 
 () 
 request 
 . 
 zone 
 = 
 zone 
 request 
 . 
 project 
 = 
 project_id 
 request 
 . 
 instance_resource 
 = 
 instance 
 # Wait for the create operation to complete. 
 print 
 ( 
 f 
 "Creating the 
 { 
 instance_name 
 } 
 instance in 
 { 
 zone 
 } 
 ..." 
 ) 
 operation 
 = 
 instance_client 
 . 
 insert 
 ( 
 request 
 = 
 request 
 ) 
 wait_for_extended_operation 
 ( 
 operation 
 , 
 "instance creation" 
 ) 
 print 
 ( 
 f 
 "Instance 
 { 
 instance_name 
 } 
 created." 
 ) 
 return 
 instance_client 
 . 
 get 
 ( 
 project 
 = 
 project_id 
 , 
 zone 
 = 
 zone 
 , 
 instance 
 = 
 instance_name 
 ) 
 def 
  
 create_with_additional_disk 
 ( 
 project_id 
 : 
 str 
 , 
 zone 
 : 
 str 
 , 
 instance_name 
 : 
 str 
 ) 
 - 
> compute_v1 
 . 
 Instance 
 : 
  
 """ 
 Create a new VM instance with Debian 10 operating system on a 20 GB disk 
 and a 25 GB additional empty disk. 
 Args: 
 project_id: project ID or project number of the Cloud project you want to use. 
 zone: name of the zone to create the instance in. For example: "us-west3-b" 
 instance_name: name of the new virtual machine (VM) instance. 
 Returns: 
 Instance object. 
 """ 
 newest_debian 
 = 
 get_image_from_family 
 ( 
 project 
 = 
 "debian-cloud" 
 , 
 family 
 = 
 "debian-12" 
 ) 
 disk_type 
 = 
 f 
 "zones/ 
 { 
 zone 
 } 
 /diskTypes/pd-standard" 
 disks 
 = 
 [ 
 disk_from_image 
 ( 
 disk_type 
 , 
 20 
 , 
 True 
 , 
 newest_debian 
 . 
 self_link 
 ), 
 empty_disk 
 ( 
 disk_type 
 , 
 25 
 ), 
 ] 
 instance 
 = 
 create_instance 
 ( 
 project_id 
 , 
 zone 
 , 
 instance_name 
 , 
 disks 
 ) 
 return 
 instance 
 

REST

You can create up to 127 non-boot disks at the time you create an instance by using the initializeParams property for each additional disk. Create additional disks with a public or private image. To add a blank disk, define the initializeParams entry with no sourceImage value. Include the disk property replicaZones to create regional disks instead of zonal disks.

POST https://compute.googleapis.com/compute/v1/projects/  PROJECT_ID 
 
/zones/  ZONE 
 
/instances

{
   "machineType":"zones/ MACHINE_TYPE_ZONE 
/machineTypes/ MACHINE_TYPE 
",
   "name":"  VM_NAME 
 
",
   
   "disks":[
      {
         "initializeParams":{
            "sourceImage":"projects/ IMAGE_PROJECT 
/global/images/ IMAGE 
"
         },
         "boot":true
      },
      {
         "initializeParams":{
            "diskSizeGb":" SIZE_GB 
",
            "sourceImage":"projects/ DISK_IMAGE_PROJECT 
/global/images/ DISK_IMAGE 
",
            "diskType":" DISK_TYPE 
"
         }
      },
      {
         "initializeParams":{
            "diskSizeGb":" SIZE_GB 
",
            "diskType":" DISK_TYPE 
"
         },
      },
      {
         "boot": false,
         "deviceName":" DISK_NAME 
",
         "initializeParams": {
            "diskType": " DISK_TYPE 
",
            "replicaZones": [
               "projects/ PROJECT_ID 
/zones/ ZONE 
",
               "projects/ PROJECT_ID 
/zones/ REMOTE_ZONE 
"
            ]
         }
      }
   ],
   
   
   "networkInterfaces":[
      {
         "network":"global/networks/ NETWORK_NAME 
"
      }
   ],
   
  
   "shieldedInstanceConfig":{
      "enableSecureBoot":" ENABLE_SECURE_BOOT 
"
   }
}

Replace the following:

  • PROJECT_ID : ID of the project to create the VM in
  • ZONE : zone to create the VM in
  • MACHINE_TYPE_ZONE : zone containing the machine type to use for the new VM
  • MACHINE_TYPE : machine type, predefined or custom , for the new VM
  • VM_NAME : name of the new VM
  • IMAGE_PROJECT : project containing the image
    For example, if you specify debian-10 as the image family, specify debian-cloud as the image project.
  • IMAGE : specify one of the following:
    • IMAGE : a specific version of a public image

      For example, "sourceImage": "projects/debian-cloud/global/images/debian-10-buster-v20200309"

    • IMAGE_FAMILY : an image family

      This creates the VM from the most recent, non-deprecated OS image. For example, if you specify "sourceImage": "projects/debian-cloud/global/images/family/debian-10" , Compute Engine creates a VM from the latest version of the OS image in the Debian 10 image family.

  • For additional disks, replace the following:

    • SIZE_GB : disk size
    • DISK_IMAGE or
    • DISK_IMAGE_FAMILY : Specify either a source image or image family for the non-boot disk:
      • DISK_IMAGE : name of the image that you want to use as a non-boot disk. For example, "sourceImage": "projects/ DISK_IMAGE_PROJECT /global/images/ DISK_IMAGE " .
      • DISK_IMAGE_FAMILY : an image family to use as a non-boot disk. For example, "sourceImage": "projects/ DISK_IMAGE_PROJECT /global/images/family/ DISK_IMAGE_FAMILY " .
    • DISK_TYPE : full or partial URL for the type of the disk type. For example, https://www.googleapis.com/compute/v1/projects/ PROJECT_ID /zones/ ZONE /diskTypes/hyperdisk-balanced .
    • DISK_NAME : Optional. The disk name displayed to the guest OS after the VM is created.
    • REMOTE_ZONE : the zone to replicate the regional disk to

    For blank disks, don't specify the sourceImage property.

    For zonal disks, don't specify the replicaZones property.

  • NETWORK_NAME : the VPC network that you want to use for the VM. You can specify default to use your default network.
  • ENABLE_SECURE_BOOT : Optional: If you chose an image that supports Shielded VM features, Compute Engine, by default, enables the virtual trusted platform module (vTPM) and integrity monitoring . Compute Engine does not enable Secure Boot by default.

    If you specify true for enableSecureBoot , Compute Engine creates a VM with all three Shielded VM features enabled. After Compute Engine starts your VM, to modify Shielded VM options, you must stop the VM.

Format and mount the disks before using them.

Create a Mobile Website
View Site in Mobile | Classic
Share by: