Class: Ansible::Ruby::Modules::Gcp_compute_instance

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance.rb

Overview

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

Instance Method Summary collapse

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

#can_ip_forward ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

    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.



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

attribute :can_ip_forward

#disks ⇒ Array<Hash>, ...

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

Returns:

  • (Array<Hash>, Hash, nil) —

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



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

attribute :disks

#guest_accelerators ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :guest_accelerators

#label_fingerprint ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :label_fingerprint

#machine_type ⇒ String?

Returns A reference to a machine type which defines VM kind.

Returns:

  • (String, nil) —

    A reference to a machine type which defines VM kind.



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

attribute :machine_type

#metadata ⇒ Hash?

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

Returns:

  • (Hash, nil) —

    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.



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

attribute :metadata

#min_cpu_platform ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :min_cpu_platform

#name ⇒ String?

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

Returns:

  • (String, nil) —

    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.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance.rb', line 41

attribute :name

#network_interfaces ⇒ Array<Hash>, ...

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

Returns:

  • (Array<Hash>, Hash, nil) —

    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.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance.rb', line 45

attribute :network_interfaces

#scheduling ⇒ Object?

Returns Sets the scheduling options for this instance.

Returns:

  • (Object, nil) —

    Sets the scheduling options for this instance.



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

attribute :scheduling

#service_accounts ⇒ Object?

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

Returns:

  • (Object, nil) —

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



52
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_instance.rb', line 52

attribute :service_accounts

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



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

attribute :state

#tags ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :tags

#zone ⇒ String

Returns A reference to the zone where the machine resides.

Returns:

  • (String) —

    A reference to the zone where the machine resides.



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

attribute :zone