Parameter |
Choices/Defaults |
Comments |
credentials_file
(added in 2.1.0) |
|
path to the JSON file associated with the service account email
|
disk_auto_delete
bool
(added in 1.9) |
|
if set boot disk will be removed after instance destruction
|
disk_size
(added in 2.3) |
Default:
10
|
The size of the boot disk created for this instance (in GB)
|
disks
(added in 1.7) |
|
a list of persistent disks to attach to the instance; a string value gives the name of the disk; alternatively, a dictionary value can define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry will be the boot disk (which must be READ_WRITE).
|
external_ip
(added in 1.9) |
Default:
ephemeral
|
type of external ip, ephemeral by default; alternatively, a fixed gce ip or ip name can be given. Specify 'none' if no external ip is desired.
|
external_projects
(added in 2.4) |
|
A list of other projects (accessible with the provisioning credentials) to be searched for the image.
|
image
|
Default:
debian-8
|
image string to use for the instance (default will follow latest stable debian image)
|
image_family
(added in 2.4) |
|
image family from which to select the image. The most recent non-deprecated image in the family will be used.
|
instance_names
|
|
a comma-separated list of instance names to create or destroy
|
ip_forward
bool
(added in 1.9) |
|
set to yes if the instance can forward ip packets (useful for gateways)
|
machine_type
|
Default:
n1-standard-1
|
machine type to use for the instance, use 'n1-standard-1' by default
|
metadata
|
|
a hash/dictionary of custom data for the instance; '{"key":"value", ...}'
|
name
|
|
either a name of a single instance or when used with 'num_instances', the base name of a cluster of nodes
aliases: base_name
|
network
|
Default:
default
|
name of the network, 'default' will be used if not specified
|
num_instances
(added in 2.3) |
|
can be used with 'name', specifies the number of nodes to provision using 'name' as a base name
|
pem_file
(added in 1.5.1) |
|
path to the pem file associated with the service account email This option is deprecated. Use 'credentials_file'.
|
persistent_boot_disk
bool |
|
if set, create the instance with a persistent boot disk
|
preemptible
bool
(added in 2.1) |
|
if set to yes , instances will be preemptible and time-limited. (requires libcloud >= 0.20.0)
|
project_id
(added in 1.5.1) |
|
your GCE project ID
|
service_account_email
(added in 1.5.1) |
|
service account email
|
service_account_permissions
(added in 2.0) |
Choices:
- bigquery
- cloud-platform
- compute-ro
- compute-rw
- useraccounts-ro
- useraccounts-rw
- datastore
- logging-write
- monitoring
- sql-admin
- storage-full
- storage-ro
- storage-rw
- taskqueue
- userinfo-email
|
|
state
|
Choices:
- active
present ←
- absent
- deleted
- started
- stopped
- terminated
|
desired state of the resource
|
subnetwork
(added in 2.2) |
|
name of the subnetwork in which the instance should be created
|
tags
|
|
a comma-separated list of tags to associate with the instance
|
zone
required |
Default:
us-central1-a
|
|