Class: Ansible::Ruby::Modules::Digital_ocean_block_storage

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

Overview

Create/destroy Block Storage volume in DigitalOcean, or attach/detach Block Storage volume to a droplet.

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

#block_size ⇒ Integer?

Returns The size of the Block Storage volume in gigabytes. Required when command=create and state=present. If snapshot_id is included, this will be ignored.

Returns:

  • (Integer, nil) —

    The size of the Block Storage volume in gigabytes. Required when command=create and state=present. If snapshot_id is included, this will be ignored.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 20

attribute :block_size

#command ⇒ :create, :attach

Returns Which operation do you want to perform.

Returns:

  • (:create, :attach) —

    Which operation do you want to perform.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 12

attribute :command

#description ⇒ Object?

Returns Description of the Block Storage volume.

Returns:

  • (Object, nil) —

    Description of the Block Storage volume.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 28

attribute :description

#droplet_id ⇒ String?

Returns The droplet id you want to operate on. Required when command=attach.

Returns:

  • (String, nil) —

    The droplet id you want to operate on. Required when command=attach.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 38

attribute :droplet_id

#region ⇒ String

Returns The slug of the region where your Block Storage volume should be located in. If snapshot_id is included, this will be ignored.

Returns:

  • (String) —

    The slug of the region where your Block Storage volume should be located in. If snapshot_id is included, this will be ignored.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 31

attribute :region

#snapshot_id ⇒ Object?

Returns The snapshot id you would like the Block Storage volume created with. If included, region and block_size will be ignored and changed to null.

Returns:

  • (Object, nil) —

    The snapshot id you would like the Block Storage volume created with. If included, region and block_size will be ignored and changed to null.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 35

attribute :snapshot_id

#state ⇒ :present, :absent

Returns Indicate desired state of the target.

Returns:

  • (:present, :absent) —

    Indicate desired state of the target.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 16

attribute :state

#volume_name ⇒ String

Returns The name of the Block Storage volume.

Returns:

  • (String) —

    The name of the Block Storage volume.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/digital_ocean/digital_ocean_block_storage.rb', line 24

attribute :volume_name