127 lines
5.2 KiB
Python
127 lines
5.2 KiB
Python
#!/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: setup
|
|
version_added: historical
|
|
short_description: Gathers facts about remote hosts
|
|
options:
|
|
gather_subset:
|
|
version_added: "2.1"
|
|
description:
|
|
- "if supplied, restrict the additional facts collected to the given subset.
|
|
Possible values: all, hardware, network, virtual, ohai, and
|
|
facter Can specify a list of values to specify a larger subset.
|
|
Values can also be used with an initial C(!) to specify that
|
|
that specific subset should not be collected. For instance:
|
|
!hardware, !network, !virtual, !ohai, !facter. Note that a few
|
|
facts are always collected. Use the filter parameter if you do
|
|
not want to display those."
|
|
required: false
|
|
default: 'all'
|
|
filter:
|
|
version_added: "1.1"
|
|
description:
|
|
- if supplied, only return facts that match this shell-style (fnmatch) wildcard.
|
|
required: false
|
|
default: '*'
|
|
fact_path:
|
|
version_added: "1.3"
|
|
description:
|
|
- path used for local ansible facts (*.fact) - files in this dir
|
|
will be run (if executable) and their results be added to ansible_local facts
|
|
if a file is not executable it is read. Check notes for Windows options. (from 2.1 on)
|
|
File/results format can be json or ini-format
|
|
required: false
|
|
default: '/etc/ansible/facts.d'
|
|
description:
|
|
- This module is automatically called by playbooks to gather useful
|
|
variables about remote hosts that can be used in playbooks. It can also be
|
|
executed directly by C(/usr/bin/ansible) to check what variables are
|
|
available to a host. Ansible provides many I(facts) about the system,
|
|
automatically.
|
|
notes:
|
|
- More ansible facts will be added with successive releases. If I(facter) or
|
|
I(ohai) are installed, variables from these programs will also be snapshotted
|
|
into the JSON file for usage in templating. These variables are prefixed
|
|
with C(facter_) and C(ohai_) so it's easy to tell their source. All variables are
|
|
bubbled up to the caller. Using the ansible facts and choosing to not
|
|
install I(facter) and I(ohai) means you can avoid Ruby-dependencies on your
|
|
remote systems. (See also M(facter) and M(ohai).)
|
|
- The filter option filters only the first level subkey below ansible_facts.
|
|
- If the target host is Windows, you will not currently have the ability to use
|
|
C(filter) as this is provided by a simpler implementation of the module.
|
|
- If the target host is Windows you can now use C(fact_path). Make sure that this path
|
|
exists on the target host. Files in this path MUST be PowerShell scripts (``*.ps1``) and
|
|
their output must be formattable in JSON (Ansible will take care of this). Test the
|
|
output of your scripts.
|
|
This option was added in Ansible 2.1.
|
|
author:
|
|
- "Ansible Core Team"
|
|
- "Michael DeHaan"
|
|
- "David O'Brien @david_obrien davidobrien1985"
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
# Display facts from all hosts and store them indexed by I(hostname) at C(/tmp/facts).
|
|
ansible all -m setup --tree /tmp/facts
|
|
|
|
# Display only facts regarding memory found by ansible on all hosts and output them.
|
|
ansible all -m setup -a 'filter=ansible_*_mb'
|
|
|
|
# Display only facts returned by facter.
|
|
ansible all -m setup -a 'filter=facter_*'
|
|
|
|
# Display only facts about certain interfaces.
|
|
ansible all -m setup -a 'filter=ansible_eth[0-2]'
|
|
|
|
# Restrict additional gathered facts to network and virtual.
|
|
ansible all -m setup -a 'gather_subset=network,virtual'
|
|
|
|
# Do not call puppet facter or ohai even if present.
|
|
ansible all -m setup -a 'gather_subset=!facter,!ohai'
|
|
|
|
# Only collect the minimum amount of facts:
|
|
ansible all -m setup -a 'gather_subset=!all'
|
|
|
|
# Display facts from Windows hosts with custom facts stored in C(C:\\custom_facts).
|
|
ansible windows -m setup -a "fact_path='c:\\custom_facts'"
|
|
"""
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
gather_subset=dict(default=["all"], required=False, type='list'),
|
|
filter=dict(default="*", required=False),
|
|
fact_path=dict(default='/etc/ansible/facts.d', required=False),
|
|
),
|
|
supports_check_mode = True,
|
|
)
|
|
data = get_all_facts(module)
|
|
module.exit_json(**data)
|
|
|
|
# import module snippets
|
|
from ansible.module_utils.basic import *
|
|
from ansible.module_utils.facts import *
|
|
|
|
if __name__ == '__main__':
|
|
main()
|