Class: Ansible::Ruby::Modules::Profitbricks_volume

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb

Overview

Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >= 1.0.0

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#auto_increment ⇒ Boolean?

Returns Whether or not to increment a single number in the name for created virtual machines.

Returns:

  • (Boolean, nil) —

    Whether or not to increment a single number in the name for created virtual machines.



43
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 43

attribute :auto_increment

#bus ⇒ :IDE, ...

Returns The bus type.

Returns:

  • (:IDE, :VIRTIO, nil) —

    The bus type.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 23

attribute :bus

#count ⇒ Integer?

Returns The number of volumes you wish to create.

Returns:

  • (Integer, nil) —

    The number of volumes you wish to create.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 39

attribute :count

#datacenter ⇒ String

Returns The datacenter in which to create the volumes.

Returns:

  • (String) —

    The datacenter in which to create the volumes.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 11

attribute :datacenter

#disk_type ⇒ String?

Returns The disk type. Currently only HDD.

Returns:

  • (String, nil) —

    The disk type. Currently only HDD.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 31

attribute :disk_type

#image ⇒ Object

Returns The system image ID for the volume, e.g. a3eae284-a2fe-11e4-b187-5f1f641608c8. This can also be a snapshot image ID.

Returns:

  • (Object) —

    The system image ID for the volume, e.g. a3eae284-a2fe-11e4-b187-5f1f641608c8. This can also be a snapshot image ID.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 27

attribute :image

#instance_ids ⇒ Array<String>, ...

Returns list of instance ids, currently only used when state=‘absent’ to remove instances.

Returns:

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

    list of instance ids, currently only used when state=‘absent’ to remove instances.



47
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 47

attribute :instance_ids

#licence_type ⇒ :LINUX, ...

Returns The licence type for the volume. This is used when the image is non-standard.

Returns:

  • (:LINUX, :WINDOWS, :UNKNOWN, :OTHER, nil) —

    The licence type for the volume. This is used when the image is non-standard.



35
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 35

attribute :licence_type

#name ⇒ String

Returns The name of the volumes. You can enumerate the names using auto_increment.

Returns:

  • (String) —

    The name of the volumes. You can enumerate the names using auto_increment.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 15

attribute :name

#size ⇒ Integer?

Returns The size of the volume.

Returns:

  • (Integer, nil) —

    The size of the volume.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 19

attribute :size

#state ⇒ :present, ...

Returns create or terminate datacenters.

Returns:

  • (:present, :absent, nil) —

    create or terminate datacenters



65
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 65

attribute :state

#subscription_password ⇒ Object?

Returns THe ProfitBricks password. Overrides the PB_PASSWORD environement variable.

Returns:

  • (Object, nil) —

    THe ProfitBricks password. Overrides the PB_PASSWORD environement variable.



54
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 54

attribute :subscription_password

#subscription_user ⇒ Object?

Returns The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environement variable.

Returns:

  • (Object, nil) —

    The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environement variable.



51
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 51

attribute :subscription_user

#wait ⇒ :yes, ...

Returns wait for the datacenter to be created before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the datacenter to be created before returning



57
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 57

attribute :wait

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



61
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/profitbricks/profitbricks_volume.rb', line 61

attribute :wait_timeout