Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/compute

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: compute1 --scope <scope> instance-templates insert ...

Required Scalar Argument

  • <project> (string)
    • Project ID for this request.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

InstanceTemplate:
  creation-timestamp: string
  description: string
  id: string
  kind: string
  name: string
  properties:
    advanced-machine-features:
      enable-nested-virtualization: boolean
      enable-uefi-networking: boolean
      threads-per-core: integer
    can-ip-forward: boolean
    confidential-instance-config:
      enable-confidential-compute: boolean
    description: string
    labels: { string: string }
    machine-type: string
    metadata:
      fingerprint: string
      kind: string
    min-cpu-platform: string
    network-performance-config:
      total-egress-bandwidth-tier: string
    private-ipv6-google-access: string
    reservation-affinity:
      consume-reservation-type: string
      key: string
      values: [string]
    resource-manager-tags: { string: string }
    resource-policies: [string]
    scheduling:
      automatic-restart: boolean
      instance-termination-action: string
      location-hint: string
      min-node-cpus: integer
      on-host-maintenance: string
      preemptible: boolean
      provisioning-model: string
    shielded-instance-config:
      enable-integrity-monitoring: boolean
      enable-secure-boot: boolean
      enable-vtpm: boolean
    tags:
      fingerprint: string
      items: [string]
  self-link: string
  source-instance: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . creation-timestamp=amet
    • [Output Only] The creation timestamp for this instance template in RFC3339 text format.
  • description=sea
    • An optional description of this resource. Provide this property when you create the resource.
  • id=et
    • [Output Only] A unique identifier for this instance template. The server defines this identifier.
  • kind=et
    • [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
  • name=et
    • Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
  • properties.advanced-machine-features enable-nested-virtualization=true
    • Whether to enable nested virtualization or not (default is false).
  • enable-uefi-networking=true
    • Whether to enable UEFI networking for instance creation.
  • threads-per-core=24

    • 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.
  • .. can-ip-forward=true

    • 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.
  • confidential-instance-config enable-confidential-compute=false

    • Defines whether the instance should have confidential compute enabled.
  • .. description=diam

    • An optional text description for the instances that are created from these properties.
  • labels=key=takimata
    • Labels to apply to instances that are created from these properties.
    • the value will be associated with the given key
  • machine-type=labore
    • The machine type to use for instances that are created from these properties.
  • metadata fingerprint=ipsum
    • 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.
  • kind=vero

    • [Output Only] Type of the resource. Always compute#metadata for metadata.
  • .. min-cpu-platform=magna

    • 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.
  • network-performance-config total-egress-bandwidth-tier=sea

    • No description provided.
  • .. private-ipv6-google-access=sadipscing

    • 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.
  • reservation-affinity consume-reservation-type=et
    • 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=accusam
    • 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=amet

    • 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.
    • Each invocation of this argument appends the given value to the array.
  • .. resource-manager-tags=key=diam

    • 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.
    • the value will be associated with the given key
  • resource-policies=aliquyam
    • Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
    • Each invocation of this argument appends the given value to the array.
  • scheduling automatic-restart=false
    • 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.
  • instance-termination-action=vero
    • Specifies the termination action for the instance.
  • location-hint=amet
    • 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.
  • min-node-cpus=22
    • The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
  • on-host-maintenance=est
    • 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 availability policies.
  • preemptible=false
    • 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.
  • provisioning-model=sit

    • Specifies the provisioning model of the instance.
  • ..shielded-instance-config enable-integrity-monitoring=true

    • Defines whether the instance has integrity monitoring enabled. Enabled by default.
  • enable-secure-boot=true
    • Defines whether the instance has Secure Boot enabled. Disabled by default.
  • enable-vtpm=false

    • Defines whether the instance has the vTPM enabled. Enabled by default.
  • ..tags fingerprint=eos

    • 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.
  • items=et

    • An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
    • Each invocation of this argument appends the given value to the array.
  • ... self-link=stet

    • [Output Only] The URL for this instance template. The server defines this URL.
  • source-instance=elitr
    • The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p request-id=string
    • An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").
  • -p user-ip=string

    • Legacy name for parameter that has been superseded by quotaUser.