Class: Ansible::Ruby::Modules::Lvol

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/lvol.rb

Overview

This module creates, removes or resizes logical volumes.

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

#active ⇒ :yes, ...

Returns Whether the volume is activate and visible to the host.

Returns:

  • (:yes, :no, nil) —

    Whether the volume is activate and visible to the host.



28
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 28

attribute :active

#force ⇒ :yes, ...

Returns Shrink or remove operations of volumes requires this switch. Ensures that that filesystems get never corrupted/destroyed by mistake.

Returns:

  • (:yes, :no, nil) —

    Shrink or remove operations of volumes requires this switch. Ensures that that filesystems get never corrupted/destroyed by mistake.



32
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 32

attribute :force

#lv ⇒ String?

Returns The name of the logical volume.

Returns:

  • (String, nil) —

    The name of the logical volume.



16
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 16

attribute :lv

#opts ⇒ String?

Returns Free-form options to be passed to the lvcreate command.

Returns:

  • (String, nil) —

    Free-form options to be passed to the lvcreate command.



36
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 36

attribute :opts

#pvs ⇒ Array<String>, ...

Returns Comma separated list of physical volumes (e.g. /dev/sda,/dev/sdb).

Returns:

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

    Comma separated list of physical volumes (e.g. /dev/sda,/dev/sdb).



44
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 44

attribute :pvs

#resizefs ⇒ :yes, ...

Returns Resize the underlying filesystem together with the logical volume.

Returns:

  • (:yes, :no, nil) —

    Resize the underlying filesystem together with the logical volume.



56
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 56

attribute :resizefs

#shrink ⇒ :yes, ...

Returns Shrink if current size is higher than size requested.

Returns:

  • (:yes, :no, nil) —

    Shrink if current size is higher than size requested.



52
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 52

attribute :shrink

#size ⇒ Integer, ...

Returns The size of the logical volume, according to lvcreate(8) –size, by default in megabytes or optionally with one of [bBsSkKmMgGtTpPeE] units; or according to lvcreate(8) –extents as a percentage of [VG|PVS|FREE]; Float values must begin with a digit. Resizing using percentage values was not supported prior to 2.1.

Returns:

  • (Integer, String, nil) —

    The size of the logical volume, according to lvcreate(8) –size, by default in megabytes or optionally with one of [bBsSkKmMgGtTpPeE] units; or according to lvcreate(8) –extents as a percentage of [VG|PVS|FREE]; Float values must begin with a digit. Resizing using percentage values was not supported prior to 2.1.



20
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 20

attribute :size

#snapshot ⇒ String?

Returns The name of the snapshot volume.

Returns:

  • (String, nil) —

    The name of the snapshot volume



40
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 40

attribute :snapshot

#state ⇒ :absent, ...

Returns Control if the logical volume exists. If C(present) and the volume does not already exist then the C(size) option is required.

Returns:

  • (:absent, :present, nil) —

    Control if the logical volume exists. If C(present) and the volume does not already exist then the C(size) option is required.



24
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 24

attribute :state

#thinpool ⇒ String?

Returns The thin pool volume name. When you want to create a thin provisioned volume, specify a thin pool volume name.

Returns:

  • (String, nil) —

    The thin pool volume name. When you want to create a thin provisioned volume, specify a thin pool volume name.



48
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 48

attribute :thinpool

#vg ⇒ String?

Returns The volume group this logical volume is part of.

Returns:

  • (String, nil) —

    The volume group this logical volume is part of.



12
 
# File 'lib/ansible/ruby/modules/generated/system/lvol.rb', line 12

attribute :vg