Class: Ansible::Ruby::Modules::Gce_instance_template

Inherits:

Base

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

Defined in:

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

Overview

Creates or destroy Google instance templates of Compute Engine of Google Cloud Platform.

Instance Method Summary

• #automatic_restart ⇒ Object^?

  Defines whether the instance should be automatically restarted when it is terminated by Compute Engine.

• #can_ip_forward ⇒ :yes, ...

  Set to C(yes) to allow instance to send/receive non-matching src/dst packets.

• #credentials_file ⇒ String^?

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

• #description ⇒ Object^?

  Description of instance template.

• #disk_auto_delete ⇒ Boolean^?

  Indicate that the boot disk should be deleted when the Node is deleted.

• #disk_type ⇒ String^?

  Specify a C(pd-standard) disk or C(pd-ssd) for an SSD disk.

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

• #disks_gce_struct ⇒ Object^?

  Support passing in the GCE-specific formatted formatted disks[] structure.

• #external_ip ⇒ String^?

  The external IP address to use.

• #image ⇒ Object^?

  The image to use to create the instance.

• #image_family ⇒ String^?

  The image family to use to create the instance.

• #metadata ⇒ Object^?

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

• #name ⇒ String^?

  The name of the GCE instance template.

• #network ⇒ String^?

  The network to associate with the instance.

• #nic_gce_struct ⇒ Object^?

  Support passing in the GCE-specific formatted networkInterfaces[] structure.

• #pem_file ⇒ Object^?

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

• #preemptible ⇒ Object^?

  Defines whether the instance is preemptible.

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

• #size ⇒ String^?

  The desired machine type for the instance template.

• #source ⇒ Object^?

  A source disk to attach to the instance.

• #state ⇒ :present, ...

  The desired state for the instance template.

• #subnetwork ⇒ Object^?

  The Subnetwork resource name for this instance.

• #subnetwork_region ⇒ Object^?

  Region that subnetwork resides in.

• #tags ⇒ Object^?

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

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

#automatic_restart ⇒ Object^?

Returns Defines whether the instance should be automatically restarted when it is terminated by Compute Engine.

Returns:

• (Object, nil) —

  Defines whether the instance should be automatically restarted when it is terminated by Compute Engine.

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

attribute :automatic_restart

#can_ip_forward ⇒ :yes, ...

Returns Set to C(yes) to allow instance to send/receive non-matching src/dst packets.

Returns:

• (:yes, :no, nil) —

  Set to C(yes) to allow instance to send/receive non-matching src/dst packets.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 49

attribute :can_ip_forward

#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/cloud/google/gce_instance_template.rb', line 96

attribute :credentials_file

#description ⇒ Object^?

Returns description of instance template.

Returns:

• (Object, nil) —

  description of instance template

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

attribute :description

#disk_auto_delete ⇒ Boolean^?

Returns Indicate that the boot disk should be deleted when the Node is deleted.

Returns:

• (Boolean, nil) —

  Indicate that the boot disk should be deleted when the Node is deleted.

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

attribute :disk_auto_delete

#disk_type ⇒ String^?

Returns Specify a C(pd-standard) disk or C(pd-ssd) for an SSD disk.

Returns:

• (String, nil) —

  Specify a C(pd-standard) disk or C(pd-ssd) for an SSD disk.

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

attribute :disk_type

#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/cloud/google/gce_instance_template.rb', line 80

attribute :disks

#disks_gce_struct ⇒ Object^?

Returns Support passing in the GCE-specific formatted formatted disks[] structure. Case sensitive. see U(cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource) for detailed information.

Returns:

• (Object, nil) —

  Support passing in the GCE-specific formatted formatted disks[] structure. Case sensitive. see U(cloud.google.com/compute/docs/reference/latest/instanceTemplates#resource) for detailed information

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 86

attribute :disks_gce_struct

#external_ip ⇒ String^?

Returns The external IP address to use. If C(ephemeral), a new non-static address will be used. If C(None), then no external address will be used. To use an existing static IP address specify address name.

Returns:

• (String, nil) —

  The external IP address to use. If C(ephemeral), a new non-static address will be used. If C(None), then no external address will be used. To use an existing static IP address specify address name.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 53

attribute :external_ip

#image ⇒ Object^?

Returns The image to use to create the instance. Cannot specify both both I(image) and I(source).

Returns:

• (Object, nil) —

  The image to use to create the instance. Cannot specify both both I(image) and I(source).

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 27

attribute :image

#image_family ⇒ String^?

Returns The image family to use to create the instance. If I(image) has been used I(image_family) is ignored. Cannot specify both I(image) and I(source).

Returns:

• (String, nil) —

  The image family to use to create the instance. If I(image) has been used I(image_family) is ignored. Cannot specify both I(image) and I(source).

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

attribute :image_family

#metadata ⇒ Object^?

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

Returns:

• (Object, nil) —

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

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 74

attribute :metadata

#name ⇒ String^?

Returns The name of the GCE instance template.

Returns:

• (String, nil) —

  The name of the GCE instance template.

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

attribute :name

#network ⇒ String^?

Returns The network to associate with the instance.

Returns:

• (String, nil) —

  The network to associate with the instance.

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

attribute :network

#nic_gce_struct ⇒ Object^?

Returns Support passing in the GCE-specific formatted networkInterfaces[] structure.

Returns:

• (Object, nil) —

  Support passing in the GCE-specific formatted networkInterfaces[] structure.

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 83

attribute :nic_gce_struct

#pem_file ⇒ Object^?

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

Returns:

• (Object, 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/cloud/google/gce_instance_template.rb', line 93

attribute :pem_file

#preemptible ⇒ Object^?

Returns Defines whether the instance is preemptible.

Returns:

• (Object, nil) —

  Defines whether the instance is preemptible.

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

attribute :preemptible

#project_id ⇒ String^?

Returns your GCE project ID.

Returns:

• (String, nil) —

  your GCE project ID

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

attribute :project_id

#service_account_email ⇒ String^?

Returns service account email.

Returns:

• (String, nil) —

  service account email

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 57

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-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/cloud/google/gce_instance_template.rb', line 61

attribute :service_account_permissions

#size ⇒ String^?

Returns The desired machine type for the instance template.

Returns:

• (String, nil) —

  The desired machine type for the instance template.

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

attribute :size

#source ⇒ Object^?

Returns A source disk to attach to the instance. Cannot specify both I(image) and I(source).

Returns:

• (Object, nil) —

  A source disk to attach to the instance. Cannot specify both I(image) and I(source).

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

attribute :source

#state ⇒ :present, ...

Returns The desired state for the instance template.

Returns:

• (:present, :absent, nil) —

  The desired state for the instance template.

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

attribute :state

#subnetwork ⇒ Object^?

Returns The Subnetwork resource name for this instance.

Returns:

• (Object, nil) —

  The Subnetwork resource name for this instance.

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

attribute :subnetwork

#subnetwork_region ⇒ Object^?

Returns Region that subnetwork resides in. (Required for subnetwork to successfully complete).

Returns:

• (Object, nil) —

  Region that subnetwork resides in. (Required for subnetwork to successfully complete)

# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_instance_template.rb', line 100

attribute :subnetwork_region

#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/cloud/google/gce_instance_template.rb', line 71

attribute :tags