Class: Ansible::Ruby::Modules::Gce

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Gce

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb

Overview

Creates or terminates Google Compute Engine (GCE) instances. See U(cloud.google.com/products/compute-engine) for an overview. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Instance Method Summary

• #credentials_file ⇒ String^?

  Path to the JSON file associated with the service account email.

• #disk_auto_delete ⇒ String^?

  If set boot disk will be removed after instance destruction.

• #disks ⇒ Object^?

  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’).

• #external_ip ⇒ String^?

  Type of external ip, ephemeral by default; alternatively, a list of fixed gce ips or ip names can be given (if there is not enough specified ip, ‘ephemeral’ will be used).

• #image ⇒ String^?

  Image string to use for the instance.

• #instance_names ⇒ Object^?

  A comma-separated list of instance names to create or destroy.

• #ip_forward ⇒ String^?

  Set to true if the instance can forward ip packets (useful for gateways).

• #machine_type ⇒ String^?

  Machine type to use for the instance, use ‘n1-standard-1’ by default.

• #metadata ⇒ Hash^?

  A hash/dictionary of custom data for the instance; ‘…’.

• #name ⇒ String^?

  Identifier when working with a single instance.

• #network ⇒ String^?

  Name of the network, ‘default’ will be used if not specified.

• #pem_file ⇒ String^?

  Path to the pem file associated with the service account email This option is deprecated.

• #persistent_boot_disk ⇒ String^?

  If set, create the instance with a persistent boot disk.

• #preemptible ⇒ String^?

  If set to true, instances will be preemptible and time-limited.

• #project_id ⇒ String^?

  Your GCE project ID.

• #service_account_email ⇒ String^?

  Service account email.

• #service_account_permissions ⇒ :bigquery, ...

  Service account permissions (see U(cloud.google.com/sdk/gcloud/reference/compute/instances/create), –scopes section for detailed information).

• #state ⇒ :active, ...

  Desired state of the resource.

• #tags ⇒ Object^?

  A comma-separated list of tags to associate with the instance.

• #zone ⇒ String

  The GCE zone to use.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#credentials_file ⇒ String^?

Returns path to the JSON file associated with the service account email.

Returns:

• (String, nil) —

  path to the JSON file associated with the service account email

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 38

attribute :credentials_file

#disk_auto_delete ⇒ String^?

Returns if set boot disk will be removed after instance destruction.

Returns:

• (String, nil) —

  if set boot disk will be removed after instance destruction

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 80

attribute :disk_auto_delete

#disks ⇒ Object^?

Returns 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).

Returns:

• (Object, nil) —

  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).

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 58

attribute :disks

#external_ip ⇒ String^?

Returns type of external ip, ephemeral by default; alternatively, a list of fixed gce ips or ip names can be given (if there is not enough specified ip, ‘ephemeral’ will be used).

Returns:

• (String, nil) —

  type of external ip, ephemeral by default; alternatively, a list of fixed gce ips or ip names can be given (if there is not enough specified ip, ‘ephemeral’ will be used)

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 76

attribute :external_ip

#image ⇒ String^?

Returns image string to use for the instance.

Returns:

• (String, nil) —

  image string to use for the instance

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 11

attribute :image

#instance_names ⇒ Object^?

Returns a comma-separated list of instance names to create or destroy.

Returns:

• (Object, nil) —

  a comma-separated list of instance names to create or destroy

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 15

attribute :instance_names

#ip_forward ⇒ String^?

Returns set to true if the instance can forward ip packets (useful for gateways).

Returns:

• (String, nil) —

  set to true if the instance can forward ip packets (useful for gateways)

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 72

attribute :ip_forward

#machine_type ⇒ String^?

Returns machine type to use for the instance, use ‘n1-standard-1’ by default.

Returns:

• (String, nil) —

  machine type to use for the instance, use ‘n1-standard-1’ by default

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 18

attribute :machine_type

#metadata ⇒ Hash^?

Returns a hash/dictionary of custom data for the instance; ‘…’.

Returns:

• (Hash, nil) —

  a hash/dictionary of custom data for the instance; ‘…’

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 22

attribute :metadata

#name ⇒ String^?

Returns identifier when working with a single instance.

Returns:

• (String, nil) —

  identifier when working with a single instance

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 46

attribute :name

#network ⇒ String^?

Returns name of the network, ‘default’ will be used if not specified.

Returns:

• (String, nil) —

  name of the network, ‘default’ will be used if not specified

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 50

attribute :network

#pem_file ⇒ String^?

Returns path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’.

Returns:

• (String, nil) —

  path to the pem file associated with the service account email This option is deprecated. Use ‘credentials_file’.

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 34

attribute :pem_file

#persistent_boot_disk ⇒ String^?

Returns if set, create the instance with a persistent boot disk.

Returns:

• (String, nil) —

  if set, create the instance with a persistent boot disk

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 54

attribute :persistent_boot_disk

#preemptible ⇒ String^?

Returns if set to true, instances will be preemptible and time-limited. (requires libcloud >= 0.20.0).

Returns:

• (String, nil) —

  if set to true, instances will be preemptible and time-limited. (requires libcloud >= 0.20.0)

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 84

attribute :preemptible

#project_id ⇒ String^?

Returns your GCE project ID.

Returns:

• (String, nil) —

  your GCE project ID

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 42

attribute :project_id

#service_account_email ⇒ String^?

Returns service account email.

Returns:

• (String, nil) —

  service account email

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 26

attribute :service_account_email

#service_account_permissions ⇒ :bigquery, ...

Returns service account permissions (see U(cloud.google.com/sdk/gcloud/reference/compute/instances/create), –scopes section for detailed information).

Returns:

• (:bigquery, :"cloud-platform", :"compute-ro", :"compute-rw", :"useraccounts-ro", :"useraccounts-rw", :datastore, :"logging-write", :monitoring, :sql, :"sql-admin", :"storage-full", :"storage-ro", :"storage-rw", :taskqueue, :"userinfo-email", nil) —

  service account permissions (see U(cloud.google.com/sdk/gcloud/reference/compute/instances/create), –scopes section for detailed information)

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 30

attribute :service_account_permissions

#state ⇒ :active, ...

Returns desired state of the resource.

Returns:

• (:active, :present, :absent, :deleted, nil) —

  desired state of the resource

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 61

attribute :state

#tags ⇒ Object^?

Returns a comma-separated list of tags to associate with the instance.

Returns:

• (Object, nil) —

  a comma-separated list of tags to associate with the instance

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 65

attribute :tags

#zone ⇒ String

Returns the GCE zone to use.

Returns:

• (String) —

  the GCE zone to use

# File 'lib/ansible/ruby/modules/generated/core/cloud/google/gce.rb', line 68

attribute :zone