Class: Ansible::Ruby::Modules::Profitbricks_volume_attachments

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb

Overview

Allows you to attach or detach a volume from a ProfitBricks server. This module has a dependency on profitbricks >= 1.0.0

Instance Method Summary

• #datacenter ⇒ String

  The datacenter in which to operate.

• #server ⇒ String

  The name of the server you wish to detach or attach the volume.

• #state ⇒ :present, ...

  Indicate desired state of the resource.

• #subscription_password ⇒ Object^?

  THe ProfitBricks password.

• #subscription_user ⇒ Object^?

  The ProfitBricks username.

• #volume ⇒ String

  The volume name or ID.

• #wait ⇒ :yes, ...

  Wait for the operation to complete before returning.

• #wait_timeout ⇒ Integer^?

  How long before wait gives up, in seconds.

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

#datacenter ⇒ String

Returns The datacenter in which to operate.

Returns:

• (String) —

  The datacenter in which to operate.

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 12

attribute :datacenter

#server ⇒ String

Returns The name of the server you wish to detach or attach the volume.

Returns:

• (String) —

  The name of the server you wish to detach or attach the volume.

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 16

attribute :server

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

• (:present, :absent, nil) —

  Indicate desired state of the resource

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 38

attribute :state

#subscription_password ⇒ Object^?

Returns THe ProfitBricks password. Overrides the PB_PASSWORD environment variable.

Returns:

• (Object, nil) —

  THe ProfitBricks password. Overrides the PB_PASSWORD environment variable.

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

attribute :subscription_password

#subscription_user ⇒ Object^?

Returns The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.

Returns:

• (Object, nil) —

  The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 24

attribute :subscription_user

#volume ⇒ String

Returns The volume name or ID.

Returns:

• (String) —

  The volume name or ID.

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 20

attribute :volume

#wait ⇒ :yes, ...

Returns wait for the operation to complete before returning.

Returns:

• (:yes, :no, nil) —

  wait for the operation to complete before returning

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 30

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

# File 'lib/ansible/ruby/modules/generated/cloud/profitbricks/profitbricks_volume_attachments.rb', line 34

attribute :wait_timeout