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

Inherits:

Base

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

Defined in:

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

Overview

Creates or terminates Google Compute Engine (GCE) instances. See U(cloud.google.com/compute) 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 ⇒ :yes, ...

  If set boot disk will be removed after instance destruction.

• #disk_size ⇒ Integer^?

  The size of the boot disk created for this instance (in GB).

• #disks ⇒ Array<Hash>, ...

  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 fixed gce ip or ip name can be given.

• #external_projects ⇒ Array<String>, ...

  A list of other projects (accessible with the provisioning credentials) to be searched for the image.

• #image ⇒ String^?

  Image string to use for the instance (default will follow latest stable debian image).

• #image_family ⇒ String^?

  Image family from which to select the image.

• #instance_names ⇒ String^?

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

• #ip_forward ⇒ :yes, ...

  Set to C(yes) 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 ⇒ Object^?

  Either a name of a single instance or when used with ‘num_instances’, the base name of a cluster of nodes.

• #network ⇒ String^?

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

• #num_instances ⇒ Object^?

  Can be used with ‘name’, specifies the number of nodes to provision using ‘name’ as a base name.

• #pem_file ⇒ Object^?

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

• #persistent_boot_disk ⇒ :yes, ...

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

• #preemptible ⇒ :yes, ...

  If set to C(yes), 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.

• #subnetwork ⇒ String^?

  Name of the subnetwork in which the instance should be created.

• #tags ⇒ Array<String>, ...

  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, fix_inclusion, #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^?

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

attribute :credentials_file

#disk_auto_delete ⇒ :yes, ...

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

attribute :disk_auto_delete

#disk_size ⇒ Integer^?

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

attribute :disk_size

#disks ⇒ Array<Hash>, ...

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

attribute :disks

#external_ip ⇒ String^?

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

attribute :external_ip

#external_projects ⇒ Array<String>, ...

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

attribute :external_projects

#image ⇒ String^?

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

attribute :image

#image_family ⇒ String^?

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

attribute :image_family

#instance_names ⇒ String^?

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

attribute :instance_names

#ip_forward ⇒ :yes, ...

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

attribute :ip_forward

#machine_type ⇒ String^?

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

attribute :machine_type

#metadata ⇒ Hash^?

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

attribute :metadata

#name ⇒ Object^?

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

attribute :name

#network ⇒ String^?

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

attribute :network

#num_instances ⇒ Object^?

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

attribute :num_instances

#pem_file ⇒ Object^?

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

attribute :pem_file

#persistent_boot_disk ⇒ :yes, ...

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

attribute :persistent_boot_disk

#preemptible ⇒ :yes, ...

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

attribute :preemptible

#project_id ⇒ String^?

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

attribute :project_id

#service_account_email ⇒ String^?

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

attribute :service_account_email

#service_account_permissions ⇒ :bigquery, ...

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

attribute :service_account_permissions

#state ⇒ :active, ...

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

attribute :state

#subnetwork ⇒ String^?

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

attribute :subnetwork

#tags ⇒ Array<String>, ...

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

attribute :tags

#zone ⇒ String

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

attribute :zone