Class: Ansible::Ruby::Modules::Crypttab

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

Overview

Control Linux encrypted block devices that are set up during system boot in C(/etc/crypttab).

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

#backing_device ⇒ Object?

Returns Path to the underlying block device or file, or the UUID of a block-device prefixed with I(UUID=).

Returns:

  • (Object, nil) —

    Path to the underlying block device or file, or the UUID of a block-device prefixed with I(UUID=).



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

attribute :backing_device

#name ⇒ String

Returns Name of the encrypted block device as it appears in the C(/etc/crypttab) file, or optionally prefixed with C(/dev/mapper/), as it appears in the filesystem. I(/dev/mapper/) will be stripped from I(name).

Returns:

  • (String) —

    Name of the encrypted block device as it appears in the C(/etc/crypttab) file, or optionally prefixed with C(/dev/mapper/), as it appears in the filesystem. I(/dev/mapper/) will be stripped from I(name).



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

attribute :name

#opts ⇒ Array<String>, ...

Returns A comma-delimited list of options. See C(crypttab(5) ) for details.

Returns:

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

    A comma-delimited list of options. See C(crypttab(5) ) for details.



27
 
# File 'lib/ansible/ruby/modules/generated/system/crypttab.rb', line 27

attribute :opts

#password ⇒ String?

Returns Encryption password, the path to a file containing the password, or C(none) or C(-) if the password should be entered at boot.

Returns:

  • (String, nil) —

    Encryption password, the path to a file containing the password, or C(none) or C(-) if the password should be entered at boot.



23
 
# File 'lib/ansible/ruby/modules/generated/system/crypttab.rb', line 23

attribute :password

#path ⇒ String?

Returns Path to file to use instead of C(/etc/crypttab). This might be useful in a chroot environment.

Returns:

  • (String, nil) —

    Path to file to use instead of C(/etc/crypttab). This might be useful in a chroot environment.



31
 
# File 'lib/ansible/ruby/modules/generated/system/crypttab.rb', line 31

attribute :path

#state ⇒ :absent, ...

Returns Use I(present) to add a line to C(/etc/crypttab) or update it’s definition if already present. Use I(absent) to remove a line with matching I(name). Use I(opts_present) to add options to those already present; options with different values will be updated. Use I(opts_absent) to remove options from the existing set.

Returns:

  • (:absent, :opts_absent, :opts_present, :present) —

    Use I(present) to add a line to C(/etc/crypttab) or update it’s definition if already present. Use I(absent) to remove a line with matching I(name). Use I(opts_present) to add options to those already present; options with different values will be updated. Use I(opts_absent) to remove options from the existing set.



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

attribute :state