library/mount
f6a09bc4
 #!/usr/bin/python
7e9e2901
 # -*- coding: utf-8 -*-
f6a09bc4
 
 # (c) 2012, Red Hat, inc
 # Written by Seth Vidal
 # based on the mount modules from salt and puppet
 #
 # This file is part of Ansible
 #
 # Ansible is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
 # Ansible is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
754888d8
 DOCUMENTATION = '''
 ---
 module: mount
 short_description: Control active and configured mount points
 description:
      - This module controls active and configured mount points in C(/etc/fstab).
 version_added: "0.6"
 options:
   name:
     description:
       - "path to the mount point, eg: C(/mnt/files)"
     required: true
     default: null
     aliases: []
   src:
     description:
       - device to be mounted on I(name).
     required: true
     default: null
   fstype:
     description:
       - file-system type
     required: true
     default: null
   opts:
     description:
       - mount options (see fstab(8))
     required: false
     default: null
   dump:
     description:
       - dump (see fstab(8))
     required: false
     default: null
   passno:
     description:
       - passno (see fstab(8))
     required: false
     default: null
   state:
     description:
       - If C(mounted) or C(unmounted), the device will be actively mounted or unmounted
         as well as just configured in I(fstab). C(absent) and C(present) only deal with
         I(fstab).
     required: true
     choices: [ "present", "absent", "mounted", "unmounted" ]
     default: null
 examples:
e16e3fb4
    - code: "mount: name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present"
754888d8
      description: "Mount DVD read-only"
 notes: []
 requirements: []
 author: Seth Vidal
 '''
 
f6a09bc4
 
 def write_fstab(lines, dest):
 
     fs_w = open(dest, 'w')
     for l in lines:
         fs_w.write(l)
 
     fs_w.flush()
     fs_w.close()
 
 def set_mount(**kwargs):
ce5f3dd1
     """ set/change a mount point location in fstab """
 
f6a09bc4
     # kwargs: name, src, fstype, opts, dump, passno, state, fstab=/etc/fstab
ce5f3dd1
     args = dict(
         opts   = 'defaults',
         dump   = '0',
         passno = '0',
         fstab  = '/etc/fstab'
     )
f6a09bc4
     args.update(kwargs)
 
faed4b5a
     new_line = '%(src)s %(name)s %(fstype)s %(opts)s %(dump)s %(passno)s\n'
f6a09bc4
 
     to_write = []
     exists = False
     changed = False
     for line in open(args['fstab'], 'r').readlines():
         if not line.strip():
477ca2ed
             to_write.append(line)
             continue
f6a09bc4
         if line.strip().startswith('#'):
             to_write.append(line)
             continue
         if len(line.split()) != 6:
             # not sure what this is or why it is here
             # but it is not our fault so leave it be
             to_write.append(line)
             continue
faed4b5a
 
f6a09bc4
         ld = {}
         ld['src'], ld['name'], ld['fstype'], ld['opts'], ld['dump'], ld['passno']  = line.split()
 
         if ld['name'] != args['name']:
             to_write.append(line)
             continue
 
         # it exists - now see if what we have is different
         exists = True
         for t in ('src', 'fstype','opts', 'dump', 'passno'):
             if ld[t] != args[t]:
                 changed = True
                 ld[t] = args[t]
 
         if changed:
477ca2ed
             to_write.append(new_line % ld)
f6a09bc4
         else:
477ca2ed
             to_write.append(line)
faed4b5a
 
f6a09bc4
     if not exists:
         to_write.append(new_line % args)
         changed = True
faed4b5a
 
f6a09bc4
     if changed:
         write_fstab(to_write, args['fstab'])
 
     return (args['name'], changed)
faed4b5a
 
f6a09bc4
 
 def unset_mount(**kwargs):
ce5f3dd1
     """ remove a mount point from fstab """
 
f6a09bc4
     # kwargs: name, src, fstype, opts, dump, passno, state, fstab=/etc/fstab
ce5f3dd1
     args = dict(
         opts   = 'default',
         dump   = '0',
         passno = '0',
         fstab  = '/etc/fstab'
     )
f6a09bc4
     args.update(kwargs)
 
     to_write = []
     changed = False
     for line in open(args['fstab'], 'r').readlines():
         if not line.strip():
477ca2ed
             to_write.append(line)
             continue
f6a09bc4
         if line.strip().startswith('#'):
             to_write.append(line)
             continue
         if len(line.split()) != 6:
             # not sure what this is or why it is here
             # but it is not our fault so leave it be
             to_write.append(line)
             continue
faed4b5a
 
f6a09bc4
         ld = {}
         ld['src'], ld['name'], ld['fstype'], ld['opts'], ld['dump'], ld['passno']  = line.split()
 
         if ld['name'] != args['name']:
             to_write.append(line)
             continue
 
         # if we got here we found a match - continue and mark changed
         changed = True
 
     if changed:
         write_fstab(to_write, args['fstab'])
 
     return (args['name'], changed)
 
faed4b5a
 
f6a09bc4
 def mount(**kwargs):
ce5f3dd1
     """ mount up a path or remount if needed """
 
f6a09bc4
     name = kwargs['name']
     if os.path.ismount(name):
477ca2ed
         cmd = [ '/bin/mount', '-o', 'remount', name ]
f6a09bc4
     else:
477ca2ed
         cmd = [ '/bin/mount', name ]
f6a09bc4
 
     call = subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     out, err = call.communicate()
     if call.returncode == 0:
         return 0, ''
     else:
483f7fd6
         return call.returncode, out+err
f6a09bc4
 
 def umount(**kwargs):
ce5f3dd1
     """ unmount a path """
 
483f7fd6
     name = kwargs['name']
f6a09bc4
     cmd = ['/bin/umount', name]
 
     call = subprocess.Popen(cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     out, err = call.communicate()
     if call.returncode == 0:
         return 0, ''
     else:
483f7fd6
         return call.returncode, out+err
 
 def main():
ce5f3dd1
 
483f7fd6
     module = AnsibleModule(
         argument_spec = dict(
             state  = dict(required=True, choices=['present', 'absent', 'mounted', 'unmounted']),
             name   = dict(required=True),
             opts   = dict(default=None),
             passno = dict(default=None),
             dump   = dict(default=None),
             src    = dict(required=True),
             fstype = dict(required=True),
             fstab  = dict(default=None)
         )
     )
faed4b5a
 
483f7fd6
     changed = False
     rc = 0
     args = {
         'name': module.params['name'],
         'src': module.params['src'],
         'fstype': module.params['fstype']
     }
     if module.params['passno'] is not None:
         args['passno'] = module.params['passno']
     if module.params['opts'] is not None:
         args['opts'] = module.params['opts']
     if module.params['dump'] is not None:
         args['dump'] = module.params['dump']
     if module.params['fstab'] is not None:
         args['fstab'] = module.params['fstab']
faed4b5a
 
483f7fd6
     # absent == remove from fstab and unmounted
     # unmounted == do not change fstab state, but unmount
     # present == add to fstab, do not change mount state
     # mounted == add to fstab if not there and make sure it is mounted, if it has changed in fstab then remount it
faed4b5a
 
483f7fd6
     state = module.params['state']
     name  = module.params['name']
     if state == 'absent':
         name, changed = unset_mount(**args)
         if changed:
             if os.path.ismount(name):
                 res,msg  = umount(**args)
                 if res:
556593bb
                     module.fail_json(msg="Error unmounting %s: %s" % (name, msg))
faed4b5a
 
483f7fd6
             if os.path.exists(name):
                 try:
                     os.rmdir(name)
                 except (OSError, IOError), e:
556593bb
                     module.fail_json(msg="Error rmdir %s: %s" % (name, str(e)))
faed4b5a
 
483f7fd6
         module.exit_json(changed=changed, **args)
faed4b5a
 
483f7fd6
     if state == 'unmounted':
f6a09bc4
         if os.path.ismount(name):
             res,msg  = umount(**args)
             if res:
556593bb
                 module.fail_json(msg="Error unmounting %s: %s" % (name, msg))
483f7fd6
             changed = True
faed4b5a
 
483f7fd6
         module.exit_json(changed=changed, **args)
faed4b5a
 
483f7fd6
     if state in ['mounted', 'present']:
         name, changed = set_mount(**args)
         if state == 'mounted':
             if not os.path.exists(name):
                 try:
                     os.makedirs(name)
                 except (OSError, IOError), e:
556593bb
                     module.fail_json(msg="Error making dir %s: %s" % (name, str(e)))
faed4b5a
 
483f7fd6
             res = 0
             if os.path.ismount(name):
                 if changed:
                     res,msg = mount(**args)
             else:
                 changed = True
f6a09bc4
                 res,msg = mount(**args)
faed4b5a
 
483f7fd6
             if res:
556593bb
                 module.fail_json(msg="Error mounting %s: %s" % (name, msg))
faed4b5a
 
 
483f7fd6
         module.exit_json(changed=changed, **args)
faed4b5a
 
483f7fd6
     module.fail_json(msg='Unexpected position reached')
     sys.exit(0)
faed4b5a
 
483f7fd6
 # this is magic, see lib/ansible/module_common.py
 #<<INCLUDE_ANSIBLE_MODULE_COMMON>>
 main()