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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/google/gce_pd.rb

Instance Method Summary

• #credentials_file ⇒ Object^?

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

• #detach_only ⇒ :yes, ...

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

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

  Type of disk provisioned.

• #image ⇒ Object^?

  The source image to use for the disk.

• #instance_name ⇒ String^?

  Instance name if you wish to attach or detach the disk.

• #mode ⇒ :READ_WRITE, ...

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

• #name ⇒ String

  Name of the disk.

• #pem_file ⇒ Object^?

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

• #project_id ⇒ Object^?

  Your GCE project ID.

• #service_account_email ⇒ Object^?

  Service account email.

• #size_gb ⇒ Integer^?

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

• #snapshot ⇒ Object^?

  The source snapshot to use for the disk.

• #state ⇒ :active, ...

  Desired state of the persistent disk.

• #zone ⇒ String^?

  Zone in which to create the disk.

Methods inherited from Base

#to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #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

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

attribute :credentials_file

#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

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

attribute :detach_only

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

Returns type of disk provisioned.

Returns:

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

  type of disk provisioned

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

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

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

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

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

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

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

attribute :mode

#name ⇒ String

Returns name of the disk.

Returns:

• (String) —

  name of the disk

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

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

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

attribute :pem_file

#project_id ⇒ Object^?

Returns your GCE project ID.

Returns:

• (Object, nil) —

  your GCE project ID

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

attribute :project_id

#service_account_email ⇒ Object^?

Returns service account email.

Returns:

• (Object, nil) —

  service account email

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

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

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

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

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

attribute :snapshot

#state ⇒ :active, ...

Returns desired state of the persistent disk.

Returns:

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

  desired state of the persistent disk

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

attribute :state

#zone ⇒ String^?

Returns zone in which to create the disk.

Returns:

• (String, nil) —

  zone in which to create the disk

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

attribute :zone