From 54a79bfc75fec5bb5f176abf4ad4bd1698258067 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Wed, 5 Feb 2014 18:36:29 -0500 Subject: [PATCH] fixed docstring and changed type to etype avoiding python builtin Signed-off-by: Brian Coca --- library/files/acl | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/library/files/acl b/library/files/acl index f6aa00f457..b8d2b85cb6 100644 --- a/library/files/acl +++ b/library/files/acl @@ -57,14 +57,14 @@ options: description: - actual user or group that the ACL applies to when matching entity types user or group are selected. - type: + etype: version_added: "1.5" required: false default: null choices: [ 'user', 'group', 'mask', 'other' ] description: - if the target is a directory, setting this to yes will make it the default acl for entities created inside the directory. It causes an error if name is a file. -d + permissions: version_added: "1.5" @@ -73,11 +73,11 @@ d description: - Permissions to apply/remove can be any combination of r, w and x (read, write and execute respectively) - entry:(deprecated) + entry: required: false default: null description: - - The acl to set or remove. This must always be quoted in the form of '::'. The qualifier may be empty for some types, but the type and perms are always requried. '-' can be used as placeholder when you do not care about permissions. This is now superceeded by entity, type and permissions fields. + - DEPRECATED. The acl to set or remove. This must always be quoted in the form of '::'. The qualifier may be empty for some types, but the type and perms are always requried. '-' can be used as placeholder when you do not care about permissions. This is now superceeded by entity, type and permissions fields. author: Brian Coca notes: @@ -86,13 +86,13 @@ notes: EXAMPLES = ''' # Grant user Joe read access to a file -- acl: name=/etc/foo.conf entity=joe type=user permissions="r" state=present +- acl: name=/etc/foo.conf entity=joe etype=user permissions="r" state=present # Removes the acl for Joe on a specific file -- acl: name=/etc/foo.conf entity=joe type=user state=absent +- acl: name=/etc/foo.conf entity=joe etype=user state=absent # Sets default acl for joe on foo.d -- acl: name=/etc/foo.d entity=joe type=user permissions=rw default=yes state=present +- acl: name=/etc/foo.d entity=joe etype=user permissions=rw default=yes state=present # Same as previous but using entry shorthand - acl: name=/etc/foo.d entrty="default:user:joe:rw-" state=present @@ -190,9 +190,9 @@ def main(): module = AnsibleModule( argument_spec = dict( name = dict(required=True,aliases=['path'], type='str'), - entry = dict(required=False, type='str'), + entry = dict(required=False, etype='str'), entity = dict(required=False, type='str', default=''), - type = dict(required=False, choices=['other', 'user', 'group', 'mask'], type='str'), + etype = dict(required=False, choices=['other', 'user', 'group', 'mask'], type='str'), permissions = dict(required=False, type='str'), state = dict(required=False, default='query', choices=[ 'query', 'present', 'absent' ], type='str'), follow = dict(required=False, type='bool', default=True), @@ -204,7 +204,7 @@ def main(): path = module.params.get('name') entry = module.params.get('entry') entity = module.params.get('entity') - type = module.params.get('type') + etype = module.params.get('etype') permissions = module.params.get('permissions') state = module.params.get('state') follow = module.params.get('follow') @@ -214,16 +214,16 @@ def main(): module.fail_json(msg="path not found or not accessible!") if state in ['present','absent']: - if not entry and not type: - module.fail_json(msg="%s requries to have ither either type and permissions or entry to be set" % state) + if not entry and not etype: + module.fail_json(msg="%s requries to have ither either etype and permissions or entry to be set" % state) if entry: - if type or entity or permissions: - module.fail_json(msg="entry and another incompatible field (entity, type or permissions) are also set") + if etype or entity or permissions: + module.fail_json(msg="entry and another incompatible field (entity, etype or permissions) are also set") if entry.count(":") not in [2,3]: module.fail_json(msg="Invalid entry: '%s', it requires 3 or 4 sections divided by ':'" % entry) - default, type, entity, permissions = split_entry(entry) + default, etype, entity, permissions = split_entry(entry) changed=False msg = "" @@ -236,8 +236,8 @@ def main(): continue old_default, old_type, old_entity, old_permissions = split_entry(oldentry) if old_default == default: - if old_type == type: - if type in ['user', 'group']: + if old_type == etype: + if etype in ['user', 'group']: if old_entity == entity: matched = True if not old_permissions == permissions: @@ -253,8 +253,8 @@ def main(): changed=True if changed and not module.check_mode: - set_acl(module,path,':'.join([type, str(entity), permissions]),follow,default) - msg="%s is present" % ':'.join([type, str(entity), permissions]) + set_acl(module,path,':'.join([etype, str(entity), permissions]),follow,default) + msg="%s is present" % ':'.join([etype, str(entity), permissions]) elif state == 'absent': for oldentry in currentacls: @@ -262,8 +262,8 @@ def main(): continue old_default, old_type, old_entity, old_permissions = split_entry(oldentry) if old_default == default: - if old_type == type: - if type in ['user', 'group']: + if old_type == etype: + if etype in ['user', 'group']: if old_entity == entity: changed=True break @@ -271,8 +271,8 @@ def main(): changed=True break if changed and not module.check_mode: - rm_acl(module,path,':'.join([type, entity, '---']),follow,default) - msg="%s is absent" % ':'.join([type, entity, '---']) + rm_acl(module,path,':'.join([etype, entity, '---']),follow,default) + msg="%s is absent" % ':'.join([etype, entity, '---']) else: msg="current acl"