archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1378 from johanwiren/fix_properties_handling

Browse Source 
Fix zfs properties handling
reviewable/pr18780/r1
Toshio Kuratomi 9 years ago
parent f6add50969 98c84c560d
commit ec5c03381b
1 changed files with 83 additions and 278 deletions
Show Stats Download Patch File Download Diff File

361
system/zfs.py
Unescape Escape View File

@ -24,7 +24,7 @@ DOCUMENTATION = '''
module: zfs module: zfs
short_description: Manage zfs short_description: Manage zfs
description: description:
- Manages ZFS file systems on Solaris and FreeBSD. Can manage file systems, volumes and snapshots. See zfs(1M) for more information about the properties. - Manages ZFS file systems, volumes, clones and snapshots.
version_added: "1.1" version_added: "1.1"
options: options:
name: name:
@ -33,192 +33,30 @@ options:
required: true required: true
state: state:
description: description:
- Whether to create (C(present)), or remove (C(absent)) a file system, snapshot or volume. - Whether to create (C(present)), or remove (C(absent)) a
file system, snapshot or volume. All parents/children
will be created/destroyed as needed to reach the desired state.
choices: ['present', 'absent']
required: true required: true
choices: [present, absent]
aclinherit:
description:
- The aclinherit property.
required: False
choices: [discard,noallow,restricted,passthrough,passthrough-x]
aclmode:
description:
- The aclmode property.
required: False
choices: [discard,groupmask,passthrough]
atime:
description:
- The atime property.
required: False
choices: ['on','off']
canmount:
description:
- The canmount property.
required: False
choices: ['on','off','noauto']
casesensitivity:
description:
- The casesensitivity property.
required: False
choices: [sensitive,insensitive,mixed]
checksum:
description:
- The checksum property.
required: False
choices: ['on','off',fletcher2,fletcher4,sha256]
compression:
description:
- The compression property.
required: False
choices: ['on','off',lzjb,gzip,gzip-1,gzip-2,gzip-3,gzip-4,gzip-5,gzip-6,gzip-7,gzip-8,gzip-9,lz4,zle]
copies:
description:
- The copies property.
required: False
choices: [1,2,3]
dedup:
description:
- The dedup property.
required: False
choices: ['on','off']
devices:
description:
- The devices property.
required: False
choices: ['on','off']
exec:
description:
- The exec property.
required: False
choices: ['on','off']
jailed:
description:
- The jailed property.
required: False
choices: ['on','off']
logbias:
description:
- The logbias property.
required: False
choices: [latency,throughput]
mountpoint:
description:
- The mountpoint property.
required: False
nbmand:
description:
- The nbmand property.
required: False
choices: ['on','off']
normalization:
description:
- The normalization property.
required: False
choices: [none,formC,formD,formKC,formKD]
origin: origin:
description: description:
- Name of the snapshot to clone - Snapshot from which to create a clone
required: False default: null
version_added: "2.0" required: false
primarycache: key_value:
description:
- The primarycache property.
required: False
choices: [all,none,metadata]
quota:
description:
- The quota property.
required: False
readonly:
description:
- The readonly property.
required: False
choices: ['on','off']
recordsize:
description:
- The recordsize property.
required: False
refquota:
description:
- The refquota property.
required: False
refreservation:
description:
- The refreservation property.
required: False
reservation:
description:
- The reservation property.
required: False
secondarycache:
description:
- The secondarycache property.
required: False
choices: [all,none,metadata]
setuid:
description: description:
- The setuid property. - The C(zfs) module takes key=value pairs for zfs properties to be set. See the zfs(8) man page for more information.
required: False default: null
choices: ['on','off'] required: false
shareiscsi:
description:
- The shareiscsi property.
required: False
choices: ['on','off']
sharenfs:
description:
- The sharenfs property.
required: False
sharesmb:
description:
- The sharesmb property.
required: False
snapdir:
description:
- The snapdir property.
required: False
choices: [hidden,visible]
sync:
description:
- The sync property.
required: False
choices: ['standard','always','disabled']
utf8only:
description:
- The utf8only property.
required: False
choices: ['on','off']
volsize:
description:
- The volsize property.
required: False
volblocksize:
description:
- The volblocksize property.
required: False
vscan:
description:
- The vscan property.
required: False
choices: ['on','off']
xattr:
description:
- The xattr property.
required: False
choices: ['on','off']
zoned:
description:
- The zoned property.
required: False
choices: ['on','off']
author: "Johan Wiren (@johanwiren)" author: "Johan Wiren (@johanwiren)"
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Create a new file system called myfs in pool rpool # Create a new file system called myfs in pool rpool with the setuid property turned off
- zfs: name=rpool/myfs state=present - zfs: name=rpool/myfs state=present setuid=off
# Create a new volume called myvol in pool rpool. # Create a new volume called myvol in pool rpool.
- zfs: name=rpool/myvol state=present volsize=10M - zfs: name=rpool/myvol state=present volsize=10M
# Create a snapshot of rpool/myfs file system. # Create a snapshot of rpool/myfs file system.
@ -237,20 +75,33 @@ EXAMPLES = '''
import os import os
class Zfs(object): class Zfs(object):
def __init__(self, module, name, properties): def __init__(self, module, name, properties):
self.module = module self.module = module
self.name = name self.name = name
self.properties = properties self.properties = properties
self.changed = False self.changed = False
self.is_solaris = os.uname()[0] == 'SunOS'
self.immutable_properties = [ 'casesensitivity', 'normalization', 'utf8only' ] self.pool = name.split('/')[0]
self.zfs_cmd = module.get_bin_path('zfs', True)
self.zpool_cmd = module.get_bin_path('zpool', True)
self.enhanced_sharing = self.check_enhanced_sharing()
def check_enhanced_sharing(self):
if os.uname()[0] == 'SunOS':
cmd = [self.zpool_cmd]
cmd.extend(['get', 'version'])
cmd.append(self.pool)
(rc, out, err) = self.module.run_command(cmd, check_rc=True)
version = out.splitlines()[-1].split()[2]
if int(version) >= 34:
return True
return False
def exists(self): def exists(self):
cmd = [self.module.get_bin_path('zfs', True)] cmd = [self.zfs_cmd, 'list', '-t', 'all', self.name]
cmd.append('list')
cmd.append('-t all')
cmd.append(self.name)
(rc, out, err) = self.module.run_command(' '.join(cmd)) (rc, out, err) = self.module.run_command(' '.join(cmd))
if rc == 0: if rc == 0:
return True return True
@ -265,7 +116,8 @@ class Zfs(object):
volsize = properties.pop('volsize', None) volsize = properties.pop('volsize', None)
volblocksize = properties.pop('volblocksize', None) volblocksize = properties.pop('volblocksize', None)
origin = properties.pop('origin', None) origin = properties.pop('origin', None)
createparent = properties.pop('createparent', None) cmd = [self.zfs_cmd]
if "@" in self.name: if "@" in self.name:
action = 'snapshot' action = 'snapshot'
elif origin: elif origin:
@ -273,135 +125,82 @@ class Zfs(object):
else: else:
action = 'create' action = 'create'
cmd = [self.module.get_bin_path('zfs', True)]
cmd.append(action) cmd.append(action)
if createparent: if action in ['create', 'clone']:
cmd.append('-p') cmd += ['-p']
if volsize:
cmd += ['-V', volsize]
if volblocksize: if volblocksize:
cmd.append('-b %s' % volblocksize) cmd += ['-b', 'volblocksize']
if properties: if properties:
for prop, value in properties.iteritems(): for prop, value in properties.iteritems():
cmd.append('-o %s="%s"' % (prop, value)) cmd += ['-o', '%s="%s"' % (prop, value)]
if volsize:
cmd.append('-V')
cmd.append(volsize)
if origin: if origin:
cmd.append(origin) cmd.append(origin)
cmd.append(self.name) cmd.append(self.name)
(rc, err, out) = self.module.run_command(' '.join(cmd)) (rc, out, err) = self.module.run_command(' '.join(cmd))
if rc == 0: if rc == 0:
self.changed = True self.changed = True
else: else:
self.module.fail_json(msg=out) self.module.fail_json(msg=err)
def destroy(self): def destroy(self):
if self.module.check_mode: if self.module.check_mode:
self.changed = True self.changed = True
return return
cmd = [self.module.get_bin_path('zfs', True)] cmd = [self.zfs_cmd, 'destroy', '-R', self.name]
cmd.append('destroy') (rc, out, err) = self.module.run_command(' '.join(cmd))
cmd.append(self.name)
(rc, err, out) = self.module.run_command(' '.join(cmd))
if rc == 0: if rc == 0:
self.changed = True self.changed = True
else: else:
self.module.fail_json(msg=out) self.module.fail_json(msg=err)
def set_property(self, prop, value): def set_property(self, prop, value):
if self.module.check_mode: if self.module.check_mode:
self.changed = True self.changed = True
return return
cmd = self.module.get_bin_path('zfs', True) cmd = [self.zfs_cmd, 'set', prop + '=' + str(value), self.name]
args = [cmd, 'set', prop + '=' + value, self.name] (rc, out, err) = self.module.run_command(cmd)
(rc, err, out) = self.module.run_command(args)
if rc == 0: if rc == 0:
self.changed = True self.changed = True
else: else:
self.module.fail_json(msg=out) self.module.fail_json(msg=err)
def set_properties_if_changed(self): def set_properties_if_changed(self):
current_properties = self.get_current_properties() current_properties = self.get_current_properties()
for prop, value in self.properties.iteritems(): for prop, value in self.properties.iteritems():
if current_properties[prop] != value: if current_properties.get(prop, None) != value:
if prop in self.immutable_properties: self.set_property(prop, value)
self.module.fail_json(msg='Cannot change property %s after creation.' % prop)
else:
self.set_property(prop, value)
def get_current_properties(self): def get_current_properties(self):
def get_properties_by_name(propname): cmd = [self.zfs_cmd, 'get', '-H']
cmd = [self.module.get_bin_path('zfs', True)] if self.enhanced_sharing:
cmd += ['get', '-H', propname, self.name] cmd += ['-e']
rc, out, err = self.module.run_command(cmd) cmd += ['all', self.name]
return [l.split('\t')[1:3] for l in out.splitlines()] rc, out, err = self.module.run_command(" ".join(cmd))
properties = dict(get_properties_by_name('all')) properties = dict()
if 'share.*' in properties: for prop, value, source in [l.split('\t')[1:4] for l in out.splitlines()]:
# Some ZFS pools list the sharenfs and sharesmb properties if source == 'local':
# hierarchically as share.nfs and share.smb respectively. properties[prop] = value
del properties['share.*'] # Add alias for enhanced sharing properties
for p, v in get_properties_by_name('share.all'): properties['sharenfs'] = properties.get('share.nfs', None)
alias = p.replace('.', '') # share.nfs -> sharenfs (etc) properties['sharesmb'] = properties.get('share.smb', None)
properties[alias] = v
return properties return properties
def run_command(self, cmd):
progname = cmd[0]
cmd[0] = module.get_bin_path(progname, True)
return module.run_command(cmd)
def main(): def main():
# FIXME: should use dict() constructor like other modules, required=False is default
module = AnsibleModule( module = AnsibleModule(
argument_spec = { argument_spec = dict(
'name': {'required': True}, name = dict(type='str', required=True),
'state': {'required': True, 'choices':['present', 'absent']}, state = dict(type='str', required=True, choices=['present', 'absent']),
'aclinherit': {'required': False, 'choices':['discard', 'noallow', 'restricted', 'passthrough', 'passthrough-x']}, # No longer used. Kept here to not interfere with zfs properties
'aclmode': {'required': False, 'choices':['discard', 'groupmask', 'passthrough']}, createparent = dict(type='bool', required=False)
'atime': {'required': False, 'choices':['on', 'off']}, ),
'canmount': {'required': False, 'choices':['on', 'off', 'noauto']}, supports_check_mode=True,
'casesensitivity': {'required': False, 'choices':['sensitive', 'insensitive', 'mixed']}, check_invalid_arguments=False
'checksum': {'required': False, 'choices':['on', 'off', 'fletcher2', 'fletcher4', 'sha256']},
'compression': {'required': False, 'choices':['on', 'off', 'lzjb', 'gzip', 'gzip-1', 'gzip-2', 'gzip-3', 'gzip-4', 'gzip-5', 'gzip-6', 'gzip-7', 'gzip-8', 'gzip-9', 'lz4', 'zle']},
'copies': {'required': False, 'choices':['1', '2', '3']},
'createparent': {'required': False, 'choices':['on', 'off']},
'dedup': {'required': False, 'choices':['on', 'off']},
'devices': {'required': False, 'choices':['on', 'off']},
'exec': {'required': False, 'choices':['on', 'off']},
# Not supported
#'groupquota': {'required': False},
'jailed': {'required': False, 'choices':['on', 'off']},
'logbias': {'required': False, 'choices':['latency', 'throughput']},
'mountpoint': {'required': False},
'nbmand': {'required': False, 'choices':['on', 'off']},
'normalization': {'required': False, 'choices':['none', 'formC', 'formD', 'formKC', 'formKD']},
'origin': {'required': False},
'primarycache': {'required': False, 'choices':['all', 'none', 'metadata']},
'quota': {'required': False},
'readonly': {'required': False, 'choices':['on', 'off']},
'recordsize': {'required': False},
'refquota': {'required': False},
'refreservation': {'required': False},
'reservation': {'required': False},
'secondarycache': {'required': False, 'choices':['all', 'none', 'metadata']},
'setuid': {'required': False, 'choices':['on', 'off']},
'shareiscsi': {'required': False, 'choices':['on', 'off']},
'sharenfs': {'required': False},
'sharesmb': {'required': False},
'snapdir': {'required': False, 'choices':['hidden', 'visible']},
'sync': {'required': False, 'choices':['standard', 'always', 'disabled']},
# Not supported
#'userquota': {'required': False},
'utf8only': {'required': False, 'choices':['on', 'off']},
'volsize': {'required': False},
'volblocksize': {'required': False},
'vscan': {'required': False, 'choices':['on', 'off']},
'xattr': {'required': False, 'choices':['on', 'off']},
'zoned': {'required': False, 'choices':['on', 'off']},
},
supports_check_mode=True
) )
state = module.params.pop('state') state = module.params.pop('state')
@ -410,10 +209,16 @@ def main():
# Get all valid zfs-properties # Get all valid zfs-properties
properties = dict() properties = dict()
for prop, value in module.params.iteritems(): for prop, value in module.params.iteritems():
if prop in ['CHECKMODE']: # All freestyle params are zfs properties
continue if prop not in module.argument_spec:
if value: # Reverse the boolification of freestyle zfs properties
properties[prop] = value if type(value) == bool:
if value is True:
properties[prop] = 'on'
else:
properties[prop] = 'off'
else:
properties[prop] = value
result = {} result = {}
result['name'] = name result['name'] = name

Write Preview
Loading…
Cancel
Save