Class: Ansible::Ruby::Modules::Gce_tag

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

Overview

This module can add or remove tags U(cloud.google.com/compute/docs/label-or-tag-resources#tags) to/from GCE instances. Use ‘instance_pattern’ to update multiple instances in a specify zone.

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

#instance_name ⇒ String?

Returns The name of the GCE instance to add/remove tags.,Required if C(instance_pattern) is not specified.

Returns:

  • (String, nil) —

    The name of the GCE instance to add/remove tags.,Required if C(instance_pattern) is not specified.



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

attribute :instance_name

#instance_pattern ⇒ String?

Returns The pattern of GCE instance names to match for adding/removing tags. Full-Python regex is supported. See U(docs.python.org/2/library/re.html) for details.,If C(instance_name) is not specified, this field is required.

Returns:

  • (String, nil) —

    The pattern of GCE instance names to match for adding/removing tags. Full-Python regex is supported. See U(docs.python.org/2/library/re.html) for details.,If C(instance_name) is not specified, this field is required.



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

attribute :instance_pattern

#pem_file ⇒ Object?

Returns Path to the PEM file associated with the service account email.

Returns:

  • (Object, nil) —

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



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_tag.rb', line 35

attribute :pem_file

#project_id ⇒ Object?

Returns Your GCE project ID.

Returns:

  • (Object, nil) —

    Your GCE project ID.



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

attribute :project_id

#service_account_email ⇒ Object?

Returns Service account email.

Returns:

  • (Object, nil) —

    Service account email.



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

attribute :service_account_email

#state ⇒ :absent, ...

Returns Desired state of the tags.

Returns:

  • (:absent, :present, nil) —

    Desired state of the tags.



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

attribute :state

#tags ⇒ Array<String>, String

Returns Comma-separated list of tags to add or remove.

Returns:

  • (Array<String>, String) —

    Comma-separated list of tags to add or remove.



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

attribute :tags

#zone ⇒ String?

Returns The zone of the disk specified by source.

Returns:

  • (String, nil) —

    The zone of the disk specified by source.



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

attribute :zone