Class: Ansible::Ruby::Modules::Parted

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

Overview

This module allows configuring block device partition using the C(parted) command line tool. For a full description of the fields and the options check the GNU parted manual.

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

#align ⇒ :none, ...

Returns Set alignment for newly created partitions.

Returns:

  • (:none, :cylinder, :minimal, :optimal, nil) —

    Set alignment for newly created partitions.



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

attribute :align

#device ⇒ String

Returns The block device (disk) where to operate.

Returns:

  • (String) —

    The block device (disk) where to operate.



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

attribute :device

#flags ⇒ Array<String>, ...

Returns A list of the flags that has to be set on the partition.

Returns:

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

    A list of the flags that has to be set on the partition.



47
 
# File 'lib/ansible/ruby/modules/generated/system/parted.rb', line 47

attribute :flags

#label ⇒ :aix, ...

Returns Creates a new disk label.

Returns:

  • (:aix, :amiga, :bsd, :dvh, :gpt, :loop, :mac, :msdos, :pc98, :sun, nil) —

    Creates a new disk label.



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

attribute :label

#name ⇒ Object?

Returns Sets the name for the partition number (GPT, Mac, MIPS and PC98 only).

Returns:

  • (Object, nil) —

    Sets the name for the partition number (GPT, Mac, MIPS and PC98 only).



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

attribute :name

#number ⇒ Integer, ...

Returns The number of the partition to work with or the number of the partition that will be created. Required when performing any action on the disk, except fetching information.

Returns:

  • (Integer, String, nil) —

    The number of the partition to work with or the number of the partition that will be created. Required when performing any action on the disk, except fetching information.



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

attribute :number

#part_end ⇒ String?

Returns Where the partition will end as offset from the beginning of the disk, that is, the “distance” from the start of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive. E.g. C(10GiB), C(15%).

Returns:

  • (String, nil) —

    Where the partition will end as offset from the beginning of the disk, that is, the “distance” from the start of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive. E.g. C(10GiB), C(15%).



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

attribute :part_end

#part_start ⇒ String?

Returns Where the partition will start as offset from the beginning of the disk, that is, the “distance” from the start of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive. E.g. C(10GiB), C(15%).

Returns:

  • (String, nil) —

    Where the partition will start as offset from the beginning of the disk, that is, the “distance” from the start of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive. E.g. C(10GiB), C(15%).



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

attribute :part_start

#part_type ⇒ :primary, ...

Returns Is one of ‘primary’, ‘extended’ or ‘logical’ and may be specified only with ‘msdos’ or ‘dvh’ partition tables. A name must be specified for a ‘gpt’ partition table. Neither part-type nor name may be used with a ‘sun’ partition table.

Returns:

  • (:primary, :extended, :logical, nil) —

    Is one of ‘primary’, ‘extended’ or ‘logical’ and may be specified only with ‘msdos’ or ‘dvh’ partition tables. A name must be specified for a ‘gpt’ partition table. Neither part-type nor name may be used with a ‘sun’ partition table.



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

attribute :part_type

#state ⇒ :present, ...

Returns If to create or delete a partition. If set to C(info) the module will only return the device information.

Returns:

  • (:present, :absent, :info, nil) —

    If to create or delete a partition. If set to C(info) the module will only return the device information.



51
 
# File 'lib/ansible/ruby/modules/generated/system/parted.rb', line 51

attribute :state

#unit ⇒ :s, ...

Returns Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret those given by the user if they are not suffixed by an unit. When fetching information about a disk, it is always recommended to specify a unit.

Returns:

  • (:s, :B, :KB, :KiB, :MB, :MiB, :GB, :GiB, :TB, :TiB, :%, :cyl, :chs, :compact, nil) —

    Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret those given by the user if they are not suffixed by an unit. When fetching information about a disk, it is always recommended to specify a unit.



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

attribute :unit