slurp 2.04 KB
Newer Older
1
#!/usr/bin/python
2
# -*- coding: utf-8 -*-
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
#
# 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/>.

Jan-Piet Mens committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
DOCUMENTATION = '''
---
module: slurp
short_description: Slurps a file from remote nodes
description:
     - This module works like M(fetch). It is used for fetching a base64-
       encoded blob containing the data in a remote file.
options:
  src:
    description:
      - The file on the remote system to fetch. This must be a file, not a
        directory.
    required: true
    default: null
    aliases: []
examples:
   - code: |
           ansible host -m slurp -a 'src=/tmp/xx'
               host | success >> {
                  "content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=", 
                  "encoding": "base64"
               }
     description: "Example using C(/usr/bin/ansible)"
notes:
   - "See also: M(fetch)"
requirements: []
author: Michael DeHaan
'''

50 51 52 53 54
def main():
    module = AnsibleModule(
        argument_spec = dict(
            src = dict(required=True),
        )
55
    )
56 57 58 59 60 61
    source = module.params['src']

    if not os.path.exists(source):
        module.fail_json(msg="file not found: %s" % source)
    if not os.access(source, os.R_OK):
        module.fail_json(msg="file is not readable: %s" % source)
62

63
    data = base64.b64encode(file(source).read())
64

65 66 67 68
    module.exit_json(content=data, encoding='base64')

# this is magic, see lib/ansible/module_common.py
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
69

70
main()
71