mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
3.0 KiB
Python
70 lines
3.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2017 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: gather_facts
|
|
version_added: 2.8
|
|
short_description: Gathers facts about remote hosts
|
|
extends_documentation_fragment:
|
|
- action_common_attributes
|
|
- action_common_attributes.facts
|
|
- action_common_attributes.flow
|
|
description:
|
|
- This module takes care of executing the R(configured facts modules,FACTS_MODULES), the default is to use the M(ansible.builtin.setup) module.
|
|
- 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.
|
|
options:
|
|
parallel:
|
|
description:
|
|
- A toggle that controls if the fact modules are executed in parallel or serially and in order.
|
|
This can guarantee the merge order of module facts at the expense of performance.
|
|
- By default it will be true if more than one fact module is used.
|
|
- For low cost/delay fact modules parallelism overhead might end up meaning the whole process takes longer.
|
|
Test your specific case to see if it is a speed improvement or not.
|
|
- The C(ansible_facts_parallel) variable can be used to set this option,
|
|
overriding the default, but not the direct assignment of the option in the task.
|
|
type: bool
|
|
attributes:
|
|
action:
|
|
support: full
|
|
async:
|
|
details: while this action does not support the task 'async' keywords it can do its own parallel processing using the O(parallel) option.
|
|
support: none
|
|
bypass_host_loop:
|
|
support: none
|
|
check_mode:
|
|
details: since this action should just query the target system info it always runs in check mode
|
|
support: full
|
|
diff_mode:
|
|
support: none
|
|
facts:
|
|
support: full
|
|
platform:
|
|
details: The action plugin should be able to automatically select the specific platform modules automatically or can be configured manually
|
|
platforms: all
|
|
notes:
|
|
- This is mostly a wrapper around other fact gathering modules.
|
|
- Options passed into this action must be supported by all the underlying fact modules configured.
|
|
- If using C(gather_timeout) and parallel execution, it will limit the total execution time of
|
|
modules that do not accept C(gather_timeout) themselves.
|
|
- Facts returned by each module will be merged, conflicts will favor 'last merged'.
|
|
Order is not guaranteed, when doing parallel gathering on multiple modules.
|
|
author:
|
|
- "Ansible Core Team"
|
|
'''
|
|
|
|
RETURN = """
|
|
# depends on the fact module called
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# Display facts from all hosts and store them indexed by hostname at /tmp/facts.
|
|
# ansible all -m ansible.builtin.gather_facts --tree /tmp/facts
|
|
"""
|