Class: Ansible::Ruby::Modules::Mount

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

Overview

This module controls active and configured mount points in C(/etc/fstab).

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#dump ⇒ Integer?

Returns dump (see fstab(5)), Note that if nulled, C(state=present) will cease to work and duplicate entries will be made with subsequent runs.

Returns:

  • (Integer, nil) —

    dump (see fstab(5)), Note that if nulled, C(state=present) will cease to work and duplicate entries will be made with subsequent runs.



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

attribute :dump

#fstab ⇒ String?

Returns file to use instead of C(/etc/fstab). You shouldn’t use that option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment.

Returns:

  • (String, nil) —

    file to use instead of C(/etc/fstab). You shouldn’t use that option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment.



39
 
# File 'lib/ansible/ruby/modules/generated/core/system/mount.rb', line 39

attribute :fstab

#fstype ⇒ String

Returns file-system type.

Returns:

  • (String) —

    file-system type



19
 
# File 'lib/ansible/ruby/modules/generated/core/system/mount.rb', line 19

attribute :fstype

#name ⇒ String

Returns path to the mount point, eg: C(/mnt/files).

Returns:

  • (String) —

    path to the mount point, eg: C(/mnt/files)



11
 
# File 'lib/ansible/ruby/modules/generated/core/system/mount.rb', line 11

attribute :name

#opts ⇒ String?

Returns mount options (see fstab(5)).

Returns:

  • (String, nil) —

    mount options (see fstab(5))



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

attribute :opts

#passno ⇒ Integer?

Returns passno (see fstab(5)), Note that if nulled, C(state=present) will cease to work and duplicate entries will be made with subsequent runs.

Returns:

  • (Integer, nil) —

    passno (see fstab(5)), Note that if nulled, C(state=present) will cease to work and duplicate entries will be made with subsequent runs.



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

attribute :passno

#src ⇒ String

Returns device to be mounted on I(name).

Returns:

  • (String) —

    device to be mounted on I(name).



15
 
# File 'lib/ansible/ruby/modules/generated/core/system/mount.rb', line 15

attribute :src

#state ⇒ :present, ...

Returns If C(mounted) or C(unmounted), the device will be actively mounted or unmounted as needed and appropriately configured in I(fstab).,C(absent) and C(present) only deal with I(fstab) but will not affect current mounting.,If specifying C(mounted) and the mount point is not present, the mount point will be created. Similarly.,Specifying C(absent) will remove the mount point directory.

Returns:

  • (:present, :absent, :mounted, :unmounted) —

    If C(mounted) or C(unmounted), the device will be actively mounted or unmounted as needed and appropriately configured in I(fstab).,C(absent) and C(present) only deal with I(fstab) but will not affect current mounting.,If specifying C(mounted) and the mount point is not present, the mount point will be created. Similarly.,Specifying C(absent) will remove the mount point directory.



35
 
# File 'lib/ansible/ruby/modules/generated/core/system/mount.rb', line 35

attribute :state