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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#backup ⇒ :yes, ...

Returns Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (:yes, :no, nil) —

    Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



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

attribute :backup

#boot ⇒ :yes, ...

Returns Determines if the filesystem should be mounted on boot.,Only applies to Solaris systems.

Returns:

  • (:yes, :no, nil) —

    Determines if the filesystem should be mounted on boot.,Only applies to Solaris systems.



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

attribute :boot

#dump ⇒ Integer?

Returns Dump (see fstab(5)). Note that if set to C(null) and I(state) set to C(present), it will cease to work and duplicate entries will be made with subsequent runs.,Has no effect on Solaris systems.

Returns:

  • (Integer, nil) —

    Dump (see fstab(5)). Note that if set to C(null) and I(state) set to C(present), it will cease to work and duplicate entries will be made with subsequent runs.,Has no effect on Solaris systems.



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

attribute :dump

#fstab ⇒ String?

Returns File to use instead of C(/etc/fstab). You shouldn’t use this option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment. OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.

Returns:

  • (String, nil) —

    File to use instead of C(/etc/fstab). You shouldn’t use this option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment. OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.



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

attribute :fstab

#fstype ⇒ String?

Returns Filesystem type. Required when I(state) is C(present) or C(mounted).

Returns:

  • (String, nil) —

    Filesystem type. Required when I(state) is C(present) or C(mounted).



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

attribute :fstype

#opts ⇒ Array<String>, ...

Returns Mount options (see fstab(5), or vfstab(4) on Solaris).

Returns:

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

    Mount options (see fstab(5), or vfstab(4) on Solaris).



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

attribute :opts

#passno ⇒ Integer?

Returns Passno (see fstab(5)). Note that if set to C(null) and I(state) set to C(present), it will cease to work and duplicate entries will be made with subsequent runs.,Deprecated on Solaris systems.

Returns:

  • (Integer, nil) —

    Passno (see fstab(5)). Note that if set to C(null) and I(state) set to C(present), it will cease to work and duplicate entries will be made with subsequent runs.,Deprecated on Solaris systems.



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

attribute :passno

#path ⇒ String

Returns Path to the mount point (e.g. C(/mnt/files)).,Before 2.3 this option was only usable as I(dest), I(destfile) and I(name).

Returns:

  • (String) —

    Path to the mount point (e.g. C(/mnt/files)).,Before 2.3 this option was only usable as I(dest), I(destfile) and I(name).



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

attribute :path

#src ⇒ String?

Returns Device to be mounted on I(path). Required when I(state) set to C(present) or C(mounted).

Returns:

  • (String, nil) —

    Device to be mounted on I(path). Required when I(state) set to C(present) or C(mounted).



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

attribute :src

#state ⇒ :absent, ...

Returns If C(mounted), the device will be actively mounted and appropriately configured in I(fstab). If the mount point is not present, the mount point will be created.,If C(unmounted), the device will be unmounted without changing I(fstab).,C(present) only specifies that the device is to be configured in I(fstab) and does not trigger or require a mount.,C(absent) specifies that the device mount’s entry will be removed from I(fstab) and will also unmount the device and remove the mount point.

Returns:

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

    If C(mounted), the device will be actively mounted and appropriately configured in I(fstab). If the mount point is not present, the mount point will be created.,If C(unmounted), the device will be unmounted without changing I(fstab).,C(present) only specifies that the device is to be configured in I(fstab) and does not trigger or require a mount.,C(absent) specifies that the device mount’s entry will be removed from I(fstab) and will also unmount the device and remove the mount point.



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

attribute :state