Class: Ansible::Ruby::Modules::Os_volume

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb

Overview

Create or Remove cinder block storage volumes

Instance Method Summary

• #availability_zone ⇒ Object^?

  Ignored.

• #display_description ⇒ Object^?

  String describing the volume.

• #display_name ⇒ Object

  Name of volume.

• #image ⇒ Object^?

  Image name or id for boot from volume.

• #scheduler_hints ⇒ Object^?

  Scheduler hints passed to volume API in form of dict.

• #size ⇒ Object^?

  Size of volume in GB.

• #snapshot_id ⇒ Object^?

  Volume snapshot id to create from.

• #state ⇒ :present, ...

  Should the resource be present or absent.

• #volume ⇒ Object^?

  Volume name or id to create from.

• #volume_type ⇒ Object^?

  Volume type for volume.

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

#availability_zone ⇒ Object^?

Returns Ignored. Present for backwards compatibility.

Returns:

• (Object, nil) —

  Ignored. Present for backwards compatibility

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 38

attribute :availability_zone

#display_description ⇒ Object^?

Returns String describing the volume.

Returns:

• (Object, nil) —

  String describing the volume

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 19

attribute :display_description

#display_name ⇒ Object

Returns Name of volume.

Returns:

• (Object) —

  Name of volume

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 15

attribute :display_name

#image ⇒ Object^?

Returns Image name or id for boot from volume.

Returns:

• (Object, nil) —

  Image name or id for boot from volume

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 25

attribute :image

#scheduler_hints ⇒ Object^?

Returns Scheduler hints passed to volume API in form of dict.

Returns:

• (Object, nil) —

  Scheduler hints passed to volume API in form of dict

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 41

attribute :scheduler_hints

#size ⇒ Object^?

Returns Size of volume in GB. This parameter is required when the I(state) parameter is 'present'.

Returns:

• (Object, nil) —

  Size of volume in GB. This parameter is required when the I(state) parameter is 'present'.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 12

attribute :size

#snapshot_id ⇒ Object^?

Returns Volume snapshot id to create from.

Returns:

• (Object, nil) —

  Volume snapshot id to create from

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 28

attribute :snapshot_id

#state ⇒ :present, ...

Returns Should the resource be present or absent.

Returns:

• (:present, :absent, nil) —

  Should the resource be present or absent.

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 34

attribute :state

#volume ⇒ Object^?

Returns Volume name or id to create from.

Returns:

• (Object, nil) —

  Volume name or id to create from

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 31

attribute :volume

#volume_type ⇒ Object^?

Returns Volume type for volume.

Returns:

• (Object, nil) —

  Volume type for volume

# File 'lib/ansible/ruby/modules/generated/cloud/openstack/os_volume.rb', line 22

attribute :volume_type