Console
    Start free

    MCP Tools Reference: compute.googleapis.com

    Tool: get_instance_template_properties

    Get instance properties of a Compute Engine instance template. This includes properties such as description, tags, machine type, network interfaces, disks, metadata, service accounts, scheduling options, labels, guest accelerators, reservation affinity, and shielded/confidential instance configurations. Requires project and instance template name as input.

    The following sample demonstrate how to use curl to invoke the get_instance_template_properties MCP tool.

    Curl Request 
    curl  
--location  
 'https://compute.googleapis.com/mcp' 
  
 \ 
--header  
 'content-type: application/json' 
  
 \ 
--header  
 'accept: application/json, text/event-stream' 
  
 \ 
--data  
 '{ 
 "method": "tools/call", 
 "params": { 
 "name": "get_instance_template_properties", 
 "arguments": { 
 // provide these details according to the tool' 
s  
MCP  
specification  
 } 
  
 } 
,  
 "jsonrpc" 
:  
 "2.0" 
,  
 "id" 
:  
 1 
 } 
 '

    Input Schema

    Request message for getting instance properties of an instance template.

    JSON representation 
     { 
 "project" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 }
    Fields
    project

    string

    Required. Project ID for this request.
    name

    string

    Required. Identifier. Name of the instance template to return.

    Output Schema

    JSON representation 
     { 
 "description" 
 : 
 string 
 , 
 "tags" 
 : 
 { 
 object ( Tags 
) 
 } 
 , 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "machineType" 
 : 
 string 
 , 
 "canIpForward" 
 : 
 boolean 
 , 
 "networkInterfaces" 
 : 
 [ 
 { 
 object ( NetworkInterface 
) 
 } 
 ] 
 , 
 "disks" 
 : 
 [ 
 { 
 object ( AttachedDisk 
) 
 } 
 ] 
 , 
 "metadata" 
 : 
 { 
 object ( Metadata 
) 
 } 
 , 
 "serviceAccounts" 
 : 
 [ 
 { 
 object ( ServiceAccount 
) 
 } 
 ] 
 , 
 "scheduling" 
 : 
 { 
 object ( Scheduling 
) 
 } 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "guestAccelerators" 
 : 
 [ 
 { 
 object ( AcceleratorConfig 
) 
 } 
 ] 
 , 
 "minCpuPlatform" 
 : 
 string 
 , 
 "reservationAffinity" 
 : 
 { 
 object ( AllocationAffinity 
) 
 } 
 , 
 "shieldedInstanceConfig" 
 : 
 { 
 object ( ShieldedInstanceConfig 
) 
 } 
 , 
 "resourcePolicies" 
 : 
 [ 
 string 
 ] 
 , 
 "confidentialInstanceConfig" 
 : 
 { 
 object ( ConfidentialInstanceConfig 
) 
 } 
 , 
 "labelsAlts" 
 : 
 [ 
 { 
 object 
 } 
 ] 
 , 
 "privateIpv6GoogleAccess" 
 : 
 enum ( InstancePrivateIpv6GoogleAccess 
) 
 , 
 "metadataAlts" 
 : 
 [ 
 { 
 object ( Metadata 
) 
 } 
 ] 
 , 
 "advancedMachineFeatures" 
 : 
 { 
 object ( AdvancedMachineFeatures 
) 
 } 
 , 
 "networkPerformanceConfig" 
 : 
 { 
 object ( NetworkPerformanceConfig 
) 
 } 
 , 
 "keyRevocationActionType" 
 : 
 enum ( KeyRevocationActionType 
) 
 }
    Fields
    description

    string

    An optional text description for the instances that are created from these properties.
    tags

    object ( Tags )

    A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 .
    resourceManagerTags

    map (key: string, value: string)

    Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags . Keys must be in the format tagKeys/{tag_key_id} , and values are in the format tagValues/456 . The field is ignored (both PUT & PATCH) when empty.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    machineType

    string

    The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4 . If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4 , the request will result in an INTERNAL_ERROR .
    canIpForward

    boolean

    Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true . If unsure, leave this set to false . See the Enable IP forwarding documentation for more information.
    networkInterfaces[]

    object ( NetworkInterface )

    An array of network access configurations for this interface.
    disks[]

    object ( AttachedDisk )

    An array of disks that are associated with the instances that are created from these properties.
    metadata

    object ( Metadata )

    The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
    serviceAccounts[]

    object ( ServiceAccount )

    A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
    scheduling

    object ( Scheduling )

    Specifies the scheduling options for the instances that are created from these properties.
    labels

    map (key: string, value: string)

    Labels to apply to instances that are created from these properties.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    guestAccelerators[]

    object ( AcceleratorConfig )

    A list of guest accelerator cards' type and count to use for instances created from these properties.
    minCpuPlatform

    string

    Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge" . For more information, read Specifying a Minimum CPU Platform .
    reservationAffinity

    object ( AllocationAffinity )

    Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
    shieldedInstanceConfig

    object ( ShieldedInstanceConfig )

    Note that for MachineImage, this is not supported yet.
    resourcePolicies[]

    string

    Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
    confidentialInstanceConfig

    object ( ConfidentialInstanceConfig )

    Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
    labelsAlts[]
    (deprecated)

    object ( Struct format)

    privateIpv6GoogleAccess

    enum ( InstancePrivateIpv6GoogleAccess )

    The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.
    metadataAlts[]
    (deprecated)

    object ( Metadata )

    advancedMachineFeatures

    object ( AdvancedMachineFeatures )

    Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
    networkPerformanceConfig

    object ( NetworkPerformanceConfig )

    Note that for MachineImage, this is not supported yet.
    keyRevocationActionType

    enum ( KeyRevocationActionType )

    KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
    JSON representation 
     { 
 "items" 
 : 
 [ 
 string 
 ] 
 , 
 "fingerprint" 
 : 
 string 
 }
    Fields
    items[]

    string

    An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035 .
    fingerprint

    string ( bytes format)

    Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

    To see the latest fingerprint, make get() request to the instance.

    A base64-encoded string.
    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "network" 
 : 
 string 
 , 
 "subnetwork" 
 : 
 string 
 , 
 "networkIP" 
 : 
 string 
 , 
 "ipv6Address" 
 : 
 string 
 , 
 "internalIpv6PrefixLength" 
 : 
 integer 
 , 
 "name" 
 : 
 string 
 , 
 "accessConfigs" 
 : 
 [ 
 { 
 object ( AccessConfig 
) 
 } 
 ] 
 , 
 "ipv6AccessConfigs" 
 : 
 [ 
 { 
 object ( AccessConfig 
) 
 } 
 ] 
 , 
 "aliasIpRanges" 
 : 
 [ 
 { 
 object ( AliasIpRange 
) 
 } 
 ] 
 , 
 "fingerprint" 
 : 
 string 
 , 
 "subnetworkAlts" 
 : 
 [ 
 string 
 ] 
 , 
 "stackType" 
 : 
 enum ( StackType 
) 
 , 
 "ipv6AccessType" 
 : 
 enum ( Ipv6AccessType 
) 
 , 
 "queueCount" 
 : 
 integer 
 , 
 "nicType" 
 : 
 enum ( NicType 
) 
 , 
 "networkAttachment" 
 : 
 string 
 , 
 "parentNicName" 
 : 
 string 
 , 
 "vlan" 
 : 
 integer 
 , 
 "igmpQuery" 
 : 
 enum ( IgmpQuery 
) 
 }
    Fields
    kind

    string

    Output only. [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

    network

    string

    URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred.

    If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

    subnetwork

    string

    The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

    networkIP

    string

    An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

    ipv6Address

    string

    An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.

    internalIpv6PrefixLength

    integer

    The prefix length of the primary internal IPv6 range.

    name

    string

    [Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7 . The default interface value is nic0 .

    accessConfigs[]

    object ( AccessConfig )

    An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT , is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

    ipv6AccessConfigs[]

    object ( AccessConfig )

    An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6 , is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

    aliasIpRanges[]

    object ( AliasIpRange )

    An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

    fingerprint

    string ( bytes format)

    Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface . An up-to-date fingerprint must be provided in order to update the NetworkInterface . The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

    A base64-encoded string.

    subnetworkAlts[]
    (deprecated)

    string

    stackType

    enum ( StackType )

    The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6 . If not specified, IPV4_ONLY is used.

    This field can be both set at instance creation and update network interface operations.

    ipv6AccessType

    enum ( Ipv6AccessType )

    Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

    Valid only if stackType is IPV4_IPV6 .

    queueCount

    integer

    The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

    nicType

    enum ( NicType )

    The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

    networkAttachment

    string

    The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

    parentNicName

    string

    Name of the parent network interface of a dynamic network interface.

    vlan

    integer

    VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.

    igmpQuery

    enum ( IgmpQuery )

    Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "type" 
 : 
 enum ( AccessType 
) 
 , 
 "name" 
 : 
 string 
 , 
 "natIP" 
 : 
 string 
 , 
 "externalIpv6" 
 : 
 string 
 , 
 "externalIpv6PrefixLength" 
 : 
 integer 
 , 
 "setPublicPtr" 
 : 
 boolean 
 , 
 "publicPtrDomainName" 
 : 
 string 
 , 
 "networkTier" 
 : 
 enum ( NetworkTier 
) 
 , 
 "securityPolicy" 
 : 
 string 
 }
    Fields
    kind

    string

    Output only. [Output Only] Type of the resource. Always compute#accessConfig for access configs.
    type

    enum ( AccessType )

    The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT . In ipv6AccessConfigs , the default and only option is DIRECT_IPV6 .
    name

    string

    The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT , but you can use any arbitrary string, such as My external IP or Network Access . In ipv6AccessConfigs , the recommend name is External IPv6 .
    natIP

    string

    Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
    externalIpv6

    string

    Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig . To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.
    externalIpv6PrefixLength

    integer

    Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.
    setPublicPtr

    boolean

    Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

    This field is not used in ipv6AccessConfig . A default PTR record will be created if the VM has external IPv6 range associated.
    publicPtrDomainName

    string

    The DNS domain name for the public PTR record.

    You can set this field only if the setPublicPtr field is enabled in accessConfig . If this field is unspecified in ipv6AccessConfig , a default PTR record will be created for first IP in associated external IPv6 range.
    networkTier

    enum ( NetworkTier )

    This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM , STANDARD .

    If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

    If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
    securityPolicy

    string

    The resource URL for the security policy associated with this access config.
    JSON representation 
     { 
 "ipCidrRange" 
 : 
 string 
 , 
 "subnetworkRangeName" 
 : 
 string 
 }
    Fields
    ipCidrRange

    string

    The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4 ), a netmask (such as /24 ) or a CIDR-formatted string (such as 10.1.2.0/24 ).
    subnetworkRangeName

    string

    The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "type" 
 : 
 enum ( DiskType 
) 
 , 
 "mode" 
 : 
 enum ( DiskMode 
) 
 , 
 "savedState" 
 : 
 enum ( DiskSavedState 
) 
 , 
 "source" 
 : 
 string 
 , 
 "deviceName" 
 : 
 string 
 , 
 "index" 
 : 
 integer 
 , 
 "boot" 
 : 
 boolean 
 , 
 "initializeParams" 
 : 
 { 
 object ( InitializeParams 
) 
 } 
 , 
 "autoDelete" 
 : 
 boolean 
 , 
 "licenses" 
 : 
 [ 
 string 
 ] 
 , 
 "interface" 
 : 
 enum ( DiskInterface 
) 
 , 
 "guestOsFeatures" 
 : 
 [ 
 { 
 object ( GuestOsFeature 
) 
 } 
 ] 
 , 
 "diskEncryptionKey" 
 : 
 { 
 object ( CustomerEncryptionKey 
) 
 } 
 , 
 "diskSizeGb" 
 : 
 string 
 , 
 "shieldedInstanceInitialState" 
 : 
 { 
 object ( InitialStateConfig 
) 
 } 
 , 
 "initializeParamsAlts" 
 : 
 [ 
 { 
 object ( InitializeParams 
) 
 } 
 ] 
 , 
 "forceAttach" 
 : 
 boolean 
 , 
 "architecture" 
 : 
 enum ( Architecture 
) 
 }
    Fields
    kind

    string

    Output only. [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
    type

    enum ( DiskType )

    Specifies the type of the disk, either SCRATCH or PERSISTENT . If not specified, the default is PERSISTENT .
    mode

    enum ( DiskMode )

    The mode in which to attach this disk, either READ_WRITE or READ_ONLY . If not specified, the default is to attach the disk in READ_WRITE mode.
    savedState

    enum ( DiskSavedState )

    Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.
    source

    string

    Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required.

    If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

    Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.
    deviceName

    string

    Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

    If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x , where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
    index

    integer

    Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
    boot

    boolean

    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    initializeParams

    object ( InitializeParams )

    [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

    This property is mutually exclusive with the source property; you can only define one or the other, but not both.
    autoDelete

    boolean

    Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    licenses[]

    string

    Output only. [Output Only] Any valid publicly visible licenses.
    interface

    enum ( DiskInterface )

    Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME . For most machine types, the default is SCSI . Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks .
    guestOsFeatures[]

    object ( GuestOsFeature )

    A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
    diskEncryptionKey

    object ( CustomerEncryptionKey )

    Encrypts or decrypts a disk using a customer-supplied encryption key .

    If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

    If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

    If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

    Note:

    Instance templates do not store customer-supplied encryption keys , so you cannot use your own keys to encrypt disks in a managed instance group .

    You cannot create VMs that have disks with customer-supplied keys using the bulk insert method .
    diskSizeGb

    string ( int64 format)

    The size of the disk in GB.
    shieldedInstanceInitialState

    object ( InitialStateConfig )

    Output only. [Output Only] shielded vm initial state stored on disk
    initializeParamsAlts[]
    (deprecated)

    object ( InitializeParams )

    forceAttach

    boolean

    [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
    architecture

    enum ( Architecture )

    Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.
    JSON representation 
     { 
 "diskName" 
 : 
 string 
 , 
 "sourceImage" 
 : 
 string 
 , 
 "diskSizeGb" 
 : 
 string 
 , 
 "diskType" 
 : 
 string 
 , 
 "sourceImageEncryptionKey" 
 : 
 { 
 object ( CustomerEncryptionKey 
) 
 } 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "sourceSnapshot" 
 : 
 string 
 , 
 "sourceSnapshotEncryptionKey" 
 : 
 { 
 object ( CustomerEncryptionKey 
) 
 } 
 , 
 "description" 
 : 
 string 
 , 
 "replicaZones" 
 : 
 [ 
 string 
 ] 
 , 
 "resourcePolicies" 
 : 
 [ 
 string 
 ] 
 , 
 "onUpdateAction" 
 : 
 enum ( OnUpdateAction 
) 
 , 
 "provisionedIops" 
 : 
 string 
 , 
 "diskSizeGbAlts" 
 : 
 [ 
 string 
 ] 
 , 
 "diskTypeAlts" 
 : 
 [ 
 string 
 ] 
 , 
 "licenses" 
 : 
 [ 
 string 
 ] 
 , 
 "architecture" 
 : 
 enum ( Architecture 
) 
 , 
 "resourceManagerTags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "provisionedThroughput" 
 : 
 string 
 , 
 "enableConfidentialCompute" 
 : 
 boolean 
 , 
 "storagePool" 
 : 
 string 
 }
    Fields
    diskName

    string

    Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

    sourceImage

    string

    The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required.

    To create a disk with one of the public operating system images , specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

    projects/debian-cloud/global/images/family/debian-9

    Alternatively, use a specific version of a public operating system image:

    projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

    To create a disk with a custom image that you created, specify the image name in the following format:

    global/images/my-custom-image

    You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name :

    global/images/family/my-image-family

    If the source image is deleted later, this field will not be set.

    diskSizeGb

    string ( int64 format)

    Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage , which is required for boot disks, the default size is the size of the sourceImage . If you do not specify a sourceImage , the default disk size is 500 GB.

    diskType

    string

    Specifies the disk type to use to create the instance. If not specified, the default is pd-standard , specified using the full URL. For example:

    https://www.googleapis.com/compute/v1/projects/ project /zones/ zone /diskTypes/pd-standard

    For a full list of acceptable values, see Persistent disk types . If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid:

    If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard .
    sourceImageEncryptionKey

    object ( CustomerEncryptionKey )

    The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

    InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys , so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

    labels

    map (key: string, value: string)

    Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    sourceSnapshot

    string

    The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required.

    To create a disk with a snapshot that you created, specify the snapshot name in the following format:

    global/snapshots/my-backup

    If the source snapshot is deleted later, this field will not be set.

    Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the bulk insert method .

    sourceSnapshotEncryptionKey

    object ( CustomerEncryptionKey )

    The customer-supplied encryption key of the source snapshot.

    description

    string

    An optional description. Provide this property when creating the disk.

    replicaZones[]

    string

    Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

    resourcePolicies[]

    string

    Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

    onUpdateAction

    enum ( OnUpdateAction )

    Specifies which action to take on instance update with this disk. Default is to use the existing disk.

    provisionedIops

    string ( int64 format)

    Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation .

    diskSizeGbAlts[]
    (deprecated)

    string ( int64 format)

    diskTypeAlts[]
    (deprecated)

    string

    licenses[]

    string

    A list of publicly visible licenses. Reserved for Google's use.

    architecture

    enum ( Architecture )

    The architecture of the attached disk. Valid values are arm64 or x86_64.

    resourceManagerTags

    map (key: string, value: string)

    Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags . Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/456 or in namespaced format such as {org_id|project_id}/{tag_key_short_name} and {tag_value_short_name} . The field is ignored (both PUT & PATCH) when empty.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    provisionedThroughput

    string ( int64 format)

    Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.

    enableConfidentialCompute

    boolean

    Whether this disk is using confidential compute mode.

    storagePool

    string

    The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

    JSON representation 
     { 
 "sha256" 
 : 
 string 
 , 
 "kmsKeyServiceAccount" 
 : 
 string 
 , 
 // Union field key 
can be only one of the following: 
 "rawKey" 
 : 
 string 
 , 
 "rsaEncryptedKey" 
 : 
 string 
 , 
 "kmsKeyName" 
 : 
 string 
 // End of list of possible types for union field key 
. 
 }
    Fields
    sha256

    string

    [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

    kmsKeyServiceAccount

    string

    The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example:

    "kmsKeyServiceAccount": " name 
@ project_id 
.iam.gserviceaccount.com/

    Union field key .

    key can be only one of the following:

    rawKey

    string

    Specifies a 256-bit customer-supplied encryption key , encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
    rsaEncryptedKey

    string

    Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey . For example:

    "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
     The key must meet the following requirements before you can provide it to Compute Engine:
    1. The key is wrapped using a RSA public key certificate provided by Google.
    2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
    Gets the RSA public key certificate provided by Google at: 
     https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
    kmsKeyName

    string

    The name of the encryption key that is stored in Google Cloud KMS. For example:

    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key
    The fully-qualifed key name may be returned for resource GET requests. For example: 
    "kmsKeyName": "projects/ kms_project_id 
/locations/ region 
/keyRings/ key_region 
/cryptoKeys/ key 
/cryptoKeyVersions/1
    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    JSON representation 
     { 
 "type" 
 : 
 enum ( FeatureType 
) 
 , 
 "typeAlts" 
 : 
 [ 
 enum ( FeatureType 
) 
 ] 
 }
    Fields
    type

    enum ( FeatureType )

    The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values:

    • VIRTIO_SCSI_MULTIQUEUE
    • WINDOWS
    • MULTI_IP_SUBNET
    • UEFI_COMPATIBLE
    • GVNIC
    • SEV_CAPABLE
    • SUSPEND_RESUME_COMPATIBLE
    • SEV_LIVE_MIGRATABLE_V2
    • SEV_SNP_CAPABLE
    • TDX_CAPABLE
    • IDPF
    • SNP_SVSM_CAPABLE
    For more information, see Enabling guest operating system features .
    typeAlts[]
    (deprecated)

    enum ( FeatureType )

    JSON representation 
     { 
 "pk" 
 : 
 { 
 object ( FileContentBuffer 
) 
 } 
 , 
 "keks" 
 : 
 [ 
 { 
 object ( FileContentBuffer 
) 
 } 
 ] 
 , 
 "dbs" 
 : 
 [ 
 { 
 object ( FileContentBuffer 
) 
 } 
 ] 
 , 
 "dbxs" 
 : 
 [ 
 { 
 object ( FileContentBuffer 
) 
 } 
 ] 
 }
    Fields
    pk

    object ( FileContentBuffer )

    The Platform Key (PK).
    keks[]

    object ( FileContentBuffer )

    The Key Exchange Key (KEK).
    dbs[]

    object ( FileContentBuffer )

    The Key Database (db).
    dbxs[]

    object ( FileContentBuffer )

    The forbidden key database (dbx).
    JSON representation 
     { 
 "content" 
 : 
 string 
 , 
 "fileType" 
 : 
 enum ( FileType 
) 
 }
    Fields
    content

    string ( bytes format)

    The raw content in the secure keys file.

    A base64-encoded string.
    fileType

    enum ( FileType )

    The file type of source file.
    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "fingerprint" 
 : 
 string 
 , 
 "items" 
 : 
 [ 
 { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 , 
 "valueAlts" 
 : 
 [ 
 string 
 ] 
 } 
 ] 
 }
    Fields
    kind

    string

    Output only. [Output Only] Type of the resource. Always compute#metadata for metadata.
    fingerprint

    string ( bytes format)

    Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet .

    To see the latest fingerprint, make a get() request to retrieve the resource.

    A base64-encoded string.
    items[]

    object

    Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
    key

    string

    Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+ , and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
    value

    string

    Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
    valueAlts[]
    (deprecated)

    string

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 , 
 "valueAlts" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    key

    string

    Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+ , and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
    value

    string

    Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
    valueAlts[]
    (deprecated)

    string

    JSON representation 
     { 
 "email" 
 : 
 string 
 , 
 "scopes" 
 : 
 [ 
 string 
 ] 
 , 
 "emailAlts" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    email

    string

    Email address of the service account.
    scopes[]

    string

    The list of scopes to be made available for this service account.
    emailAlts[]
    (deprecated)

    string

    JSON representation 
     { 
 "onHostMaintenance" 
 : 
 enum ( OnHostMaintenance 
) 
 , 
 "automaticRestart" 
 : 
 boolean 
 , 
 "preemptible" 
 : 
 boolean 
 , 
 "nodeAffinities" 
 : 
 [ 
 { 
 object ( NodeAffinity 
) 
 } 
 ] 
 , 
 "minNodeCpus" 
 : 
 integer 
 , 
 "locationHint" 
 : 
 string 
 , 
 "availabilityDomain" 
 : 
 integer 
 , 
 "provisioningModel" 
 : 
 enum ( ProvisioningModel 
) 
 , 
 "instanceTerminationAction" 
 : 
 enum ( InstanceTerminationAction 
) 
 , 
 "hostErrorTimeoutSeconds" 
 : 
 integer 
 , 
 "localSsdRecoveryTimeout" 
 : 
 { 
 object ( Duration 
) 
 } 
 , 
 "skipGuestOsShutdown" 
 : 
 boolean 
 , 
 // Union field run_duration 
can be only one of the following: 
 "maxRunDuration" 
 : 
 { 
 object ( Duration 
) 
 } 
 , 
 "terminationTime" 
 : 
 string 
 // End of list of possible types for union field run_duration 
. 
 // Union field on_instance_termination_action 
can be only one of the following: 
 "onInstanceStopAction" 
 : 
 { 
 object ( OnInstanceStopAction 
) 
 } 
 // End of list of possible types for union field 
 // on_instance_termination_action 
. 
 }
    Fields
    onHostMaintenance

    enum ( OnHostMaintenance )

    Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE . For preemptible instances , the default and only possible behavior is TERMINATE . For more information, see Set VM host maintenance policy .

    automaticRestart

    boolean

    Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

    By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

    preemptible

    boolean

    Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.

    nodeAffinities[]

    object ( NodeAffinity )

    A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

    minNodeCpus

    integer

    The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

    locationHint

    string

    An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

    availabilityDomain

    integer

    Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

    provisioningModel

    enum ( ProvisioningModel )

    Specifies the provisioning model of the instance.

    instanceTerminationAction

    enum ( InstanceTerminationAction )

    Specifies the termination action for the instance.

    hostErrorTimeoutSeconds

    integer

    Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

    localSsdRecoveryTimeout

    object ( Duration )

    Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

    skipGuestOsShutdown

    boolean

    Default is false and there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs.

    Union field run_duration .

    run_duration can be only one of the following:

    maxRunDuration

    object ( Duration )

    Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.

    terminationTime

    string

    Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.

    Union field on_instance_termination_action . Defines the behaviour for instances with the instance_termination_actions. At the end of the run duration or termination time, the instance will be terminated according to the properties defined in the action. There can be only one termination action specified for an instance. on_instance_termination_action can be only one of the following:
    onInstanceStopAction

    object ( OnInstanceStopAction )

    JSON representation 
     { 
 "seconds" 
 : 
 string 
 , 
 "nanos" 
 : 
 integer 
 }
    Fields
    seconds

    string ( int64 format)

    Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
    nanos

    integer

    Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
    JSON representation 
     { 
 "discardLocalSsd" 
 : 
 boolean 
 }
    Fields
    discardLocalSsd

    boolean

    If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time.
    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "operator" 
 : 
 enum ( Operator 
) 
 , 
 "values" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    key

    string

    Corresponds to the label key of Node resource.
    operator

    enum ( Operator )

    Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
    values[]

    string

    Corresponds to the label values of Node resource.
    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    JSON representation 
     { 
 "acceleratorType" 
 : 
 string 
 , 
 "acceleratorCount" 
 : 
 integer 
 , 
 "acceleratorCountAlts" 
 : 
 [ 
 integer 
 ] 
 }
    Fields
    acceleratorType

    string

    Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
    acceleratorCount

    integer

    The number of the guest accelerator cards exposed to this instance.
    acceleratorCountAlts[]
    (deprecated)

    integer

    JSON representation 
     { 
 "consumeReservationType" 
 : 
 enum ( Type 
) 
 , 
 "key" 
 : 
 string 
 , 
 "values" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    consumeReservationType

    enum ( Type )

    Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION , or NO_RESERVATION . See Consuming reserved instances for examples.
    key

    string

    Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
    values[]

    string

    Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.
    JSON representation 
     { 
 "enableSecureBoot" 
 : 
 boolean 
 , 
 "enableVtpm" 
 : 
 boolean 
 , 
 "enableIntegrityMonitoring" 
 : 
 boolean 
 }
    Fields
    enableSecureBoot

    boolean

    Defines whether the instance has Secure Boot enabled. Disabled by default .
    enableVtpm

    boolean

    Defines whether the instance has the vTPM enabled. Enabled by default .
    enableIntegrityMonitoring

    boolean

    Defines whether the instance has integrity monitoring enabled. Enabled by default .
    JSON representation 
     { 
 "enableConfidentialCompute" 
 : 
 boolean 
 , 
 "confidentialInstanceType" 
 : 
 enum ( ConfidentialInstanceType 
) 
 }
    Fields
    enableConfidentialCompute

    boolean

    Defines whether the instance should have confidential compute enabled.
    confidentialInstanceType

    enum ( ConfidentialInstanceType )

    Defines the type of technology used by the confidential instance.
    JSON representation 
     { 
 "fields" 
 : 
 { 
 string 
 : 
 value 
 , 
 ... 
 } 
 }
    Fields
    fields

    map (key: string, value: value ( Value format))

    Unordered map of dynamically typed values.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 value 
 }
    Fields
    key

    string

    value

    value ( Value format)

    JSON representation 
     { 
 // Union field kind 
can be only one of the following: 
 "nullValue" 
 : 
 null 
 , 
 "numberValue" 
 : 
 number 
 , 
 "stringValue" 
 : 
 string 
 , 
 "boolValue" 
 : 
 boolean 
 , 
 "structValue" 
 : 
 { 
 object 
 } 
 , 
 "listValue" 
 : 
 array 
 // End of list of possible types for union field kind 
. 
 }
    Fields
    Union field kind . The kind of value. kind can be only one of the following:
    nullValue

    null

    Represents a null value.

    numberValue

    number

    Represents a double value.

    stringValue

    string

    Represents a string value.

    boolValue

    boolean

    Represents a boolean value.

    structValue

    object ( Struct format)

    Represents a structured value.

    listValue

    array ( ListValue format)

    Represents a repeated Value .

    JSON representation 
     { 
 "values" 
 : 
 [ 
 value 
 ] 
 }
    Fields
    values[]

    value ( Value format)

    Repeated field of dynamically typed values.
    JSON representation 
     { 
 "enableNestedVirtualization" 
 : 
 boolean 
 , 
 "threadsPerCore" 
 : 
 integer 
 , 
 "visibleCoreCount" 
 : 
 integer 
 , 
 "enableUefiNetworking" 
 : 
 boolean 
 , 
 "performanceMonitoringUnit" 
 : 
 enum ( PerformanceMonitoringUnit 
) 
 , 
 "turboMode" 
 : 
 string 
 }
    Fields
    enableNestedVirtualization

    boolean

    Whether to enable nested virtualization or not (default is false).
    threadsPerCore

    integer

    The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
    visibleCoreCount

    integer

    The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.
    enableUefiNetworking

    boolean

    Whether to enable UEFI networking for instance creation.
    performanceMonitoringUnit

    enum ( PerformanceMonitoringUnit )

    Type of Performance Monitoring Unit requested on instance.
    turboMode

    string

    Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX

    Using empty string or not setting this field will use the platform-specific default turbo mode.
    JSON representation 
     { 
 "totalEgressBandwidthTier" 
 : 
 enum ( Tier 
) 
 }
    Fields
    totalEgressBandwidthTier

    enum ( Tier )

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: