ansible/system/facter

#!/usr/bin/python
# -*- coding: utf-8 -*-

# (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/>.
#


DOCUMENTATION = '''
---
module: facter
short_description: Runs the discovery program I(facter) on the remote system
description:
     - Runs the I(facter) discovery program
       (U(https://github.com/puppetlabs/facter)) on the remote system, returning
       JSON data that can be useful for inventory purposes.
version_added: "0.2"
options: {}
examples:
   - code: ansible www.example.net -m facter
     description: "Example command-line invocation"
notes: []
requirements: [ "facter", "ruby-json" ]
author: Michael DeHaan
'''

def main():
    module = AnsibleModule(
        argument_spec = dict()
    )

    cmd = ["/usr/bin/env", "facter", "--json"]
    rc, out, err = module.run_command(cmd, check_rc=True)
    module.exit_json(**json.loads(out))

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

main()
Standardizing the module 13 years ago			`#!/usr/bin/python`
Add encoding lines to python modules such that they can take unicode options if they are fed them, since the AnsibleModule stuff no longer base64 encodes for simplicity and speed reasons. 13 years ago			`# -- coding: utf-8 --`
Example facter module. Look how quick that was. 13 years ago
Relicensing to GPLv3, all previous committers ok'd on mailing list. 13 years ago			`# (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/>.`
			`#`

DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 12 years ago
			`DOCUMENTATION = '''`
			`---`
			`module: facter`
module_formatter now also uses Jinja2 trim_blocks - Updated man template accordingly - seem to have left in illegal char in facter DOCUMENTATION... 12 years ago			`short_description: Runs the discovery program I(facter) on the remote system`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 12 years ago			`description:`
Jumbo DOCUMENTATION patch 12 years ago			`- Runs the I(facter) discovery program`
			`(U(https://github.com/puppetlabs/facter)) on the remote system, returning`
			`JSON data that can be useful for inventory purposes.`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 12 years ago			`version_added: "0.2"`
Module documentation should have options sorted 12 years ago			`options: {}`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 12 years ago			`examples:`
Erroneous space in facter documentation. 12 years ago			`- code: ansible www.example.net -m facter`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 12 years ago			`description: "Example command-line invocation"`
			`notes: []`
			`requirements: [ "facter", "ruby-json" ]`
			`author: Michael DeHaan`
			`'''`
Example facter module. Look how quick that was. 13 years ago
Standardizing the module 13 years ago			`def main():`
Make pep8 tests run against the library directory as well, and associated tweaks (mostly to indentation) in the library directory. 12 years ago			`module = AnsibleModule(`
			`argument_spec = dict()`
			`)`

Update modules to use run_command in module_common.py This updates apt, apt_repository, command, cron, easy_install, facter, fireball, git, group, mount, ohai, pip, service, setup, subversion, supervisorctl, svr4pkg, user, and yum to take advantage of run_command in module_common.py. 12 years ago			`cmd = ["/usr/bin/env", "facter", "--json"]`
Various cleanup to run_command * Rename fail_on_rc_non_zero to check_rc, much more succinct. * Simplify method defintion * Fix command module and drop shell=shell option; whether to use shell is determined by if args is a list. 12 years ago			`rc, out, err = module.run_command(cmd, check_rc=True)`
Update modules to use run_command in module_common.py This updates apt, apt_repository, command, cron, easy_install, facter, fireball, git, group, mount, ohai, pip, service, setup, subversion, supervisorctl, svr4pkg, user, and yum to take advantage of run_command in module_common.py. 12 years ago			`module.exit_json(**json.loads(out))`
Standardizing the module 13 years ago
			`# this is magic, see lib/ansible/module_common.py`
			`#<<INCLUDE_ANSIBLE_MODULE_COMMON>>`

			`main()`