Resource Type: gcompute_instance

Defined in:

lib/puppet/type/gcompute_instance.rb

Providers:

google

Overview

An instance is a virtual machine (VM) hosted on Google’s infrastructure.

Properties

• can_ip_forward

  Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.

  Supported values:

  • true
  • false
• cpu_platform

  The CPU platform used by this instance. (output only)

• creation_timestamp

  Creation timestamp in RFC3339 text format. (output only)

• disks

  An array of disks that are associated with the instances that are created from this template.

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• guest_accelerators

  List of the type and count of accelerator cards attached to the instance

• id

  The unique identifier for the resource. This identifier is defined by the server. (output only)

• label_fingerprint

  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.

• machine_type

  A reference to MachineType resource

• metadata

  The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys.

• min_cpu_platform

  Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms

• name (namevar)

  The name of the resource, provided by the client when initially creating the resource. The resource 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])? 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.

• network_interfaces

  An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.

• scheduling

  Sets the scheduling options for this instance.

• service_accounts

  A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

• status

  The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED. (output only)

• status_message

  An optional, human-readable explanation of the status. (output only)

• tags

  A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.

Parameters

• credential

  A gauth_credential name to be used to authenticate with Google Cloud Platform.

• name

  The name of the Instance.

• project

  A Google Cloud Platform project to manage.

• provider

  The specific backend to use for this ‘gcompute_instance` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• zone

  A reference to Zone resource