ansible/library/write_string.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2017 Intel Corporation
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #      http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 DOCUMENTATION = '''
  17 ---
  18 module: write_string
  19 short_description: write a string to a file
  20 description:
  21     - write a string to a file without using temp files
  22 options:
  23   path: path to write to
  24   val: string to write
  25   mode: python file mode (w, wb, a, ab)
  26 '''
  27
  28
  29 def main():
  30     module = AnsibleModule(
  31         argument_spec={
  32             'path': {'required': True, 'type': 'path', 'aliases': ['dest']},
  33             'val': {'required': True, 'type': 'str'},
  34             'mode': {'required': False, 'default': "w", 'type': 'str',
  35                      'choices': ['w', 'wb', 'a', 'ab']}}
  36     )
  37     params = module.params
  38     path = params['path']
  39     mode = params['mode']
  40     val = params['val']
  41     with open(path, mode) as file_object:
  42         file_object.write(val)
  43
  44     module.exit_json(changed=True)
  45
  46
  47 # <<INCLUDE_ANSIBLE_MODULE_COMMON>>
  48 from ansible.module_utils.basic import *  # noqa
  49
  50 if __name__ == '__main__':
  51     main()