Class: Ansible::Ruby::Modules::Gce_pd

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

Overview

This module can create and destroy unformatted GCE persistent disks U(developers.google.com/compute/docs/disks#persistentdisks). It also supports attaching and detaching disks from running instances. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

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

#credentials_file ⇒ Object?

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

Returns:

  • (Object, nil) —

    path to the JSON file associated with the service account email



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

attribute :credentials_file

#delete_on_termination ⇒ :yes, ...

Returns If C(yes), deletes the volume when instance is terminated.

Returns:

  • (:yes, :no, nil) —

    If C(yes), deletes the volume when instance is terminated



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gce_pd.rb', line 62

attribute :delete_on_termination

#detach_only ⇒ :yes, ...

Returns do not destroy the disk, merely detach it from an instance.

Returns:

  • (:yes, :no, nil) —

    do not destroy the disk, merely detach it from an instance



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

attribute :detach_only

#disk_type ⇒ :"pd-standard", ...

Returns type of disk provisioned.

Returns:

  • (:"pd-standard", :"pd-ssd", nil) —

    type of disk provisioned



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

attribute :disk_type

#image ⇒ Object?

Returns the source image to use for the disk.

Returns:

  • (Object, nil) —

    the source image to use for the disk



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

attribute :image

#instance_name ⇒ String?

Returns instance name if you wish to attach or detach the disk.

Returns:

  • (String, nil) —

    instance name if you wish to attach or detach the disk



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

attribute :instance_name

#mode ⇒ :READ_WRITE, ...

Returns GCE mount mode of disk, READ_ONLY (default) or READ_WRITE.

Returns:

  • (:READ_WRITE, :READ_ONLY, nil) —

    GCE mount mode of disk, READ_ONLY (default) or READ_WRITE



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

attribute :mode

#name ⇒ String

Returns name of the disk.

Returns:

  • (String) —

    name of the disk



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

attribute :name

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



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

attribute :pem_file

#project_id ⇒ Object?

Returns your GCE project ID.

Returns:

  • (Object, nil) —

    your GCE project ID



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

attribute :project_id

#service_account_email ⇒ Object?

Returns service account email.

Returns:

  • (Object, nil) —

    service account email



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

attribute :service_account_email

#size_gb ⇒ Integer?

Returns whole integer size of disk (in GB) to create, default is 10 GB.

Returns:

  • (Integer, nil) —

    whole integer size of disk (in GB) to create, default is 10 GB



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

attribute :size_gb

#snapshot ⇒ Object?

Returns the source snapshot to use for the disk.

Returns:

  • (Object, nil) —

    the source snapshot to use for the disk



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

attribute :snapshot

#state ⇒ :active, ...

Returns desired state of the persistent disk.

Returns:

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

    desired state of the persistent disk



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

attribute :state

#zone ⇒ String?

Returns zone in which to create the disk.

Returns:

  • (String, nil) —

    zone in which to create the disk



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

attribute :zone