Google
Edit File: setup.cpython-39.pyc
a �)g.+ � @ s� d dl mZmZmZ eZdZdZddlm Z d dl m Z d dl m Z mZ d dlmZmZmZ d d lmZ d d � Zed kr~e� d S )� )�absolute_import�division�print_functiona� --- 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: C(all), C(all_ipv4_addresses), C(all_ipv6_addresses), C(apparmor), C(architecture), C(caps), C(chroot),C(cmdline), C(date_time), C(default_ipv4), C(default_ipv6), C(devices), C(distribution), C(distribution_major_version), C(distribution_release), C(distribution_version), C(dns), C(effective_group_ids), C(effective_user_id), C(env), C(facter), C(fips), C(hardware), C(interfaces), C(is_chroot), C(iscsi), C(kernel), C(local), C(lsb), C(machine), C(machine_id), C(mounts), C(network), C(ohai), C(os_family), C(pkg_mgr), C(platform), C(processor), C(processor_cores), C(processor_count), C(python), C(python_version), C(real_user_id), C(selinux), C(service_mgr), C(ssh_host_key_dsa_public), C(ssh_host_key_ecdsa_public), C(ssh_host_key_ed25519_public), C(ssh_host_key_rsa_public), C(ssh_host_pub_keys), C(ssh_pub_keys), C(system), C(system_capabilities), C(system_capabilities_enforced), C(user), C(user_dir), C(user_gecos), C(user_gid), C(user_id), C(user_shell), C(user_uid), C(virtual), C(virtualization_role), C(virtualization_type). 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: C(!hardware,!network,!virtual,!ohai,!facter). If C(!all) is specified then only the min subset is collected. To avoid collecting even the min subset, specify C(!all,!min). To collect only specific facts, use C(!all,!min), and specify the particular fact subsets. Use the filter parameter if you do not want to display some collected facts." type: list elements: str default: "all" gather_timeout: version_added: "2.2" description: - Set the default timeout in seconds for individual fact gathering. type: int default: 10 filter: version_added: "1.1" description: - If supplied, only return facts that match one of the shell-style (fnmatch) pattern. An empty list basically means 'no filter'. As of Ansible 2.11, the type has changed from string to list and the default has became an empty list. A simple string is still accepted and works as a single pattern. The behaviour prior to Ansible 2.11 remains. type: list elements: str default: [] fact_path: version_added: "1.3" description: - Path used for local ansible facts (C(*.fact)) - files in this dir will be run (if executable) and their results be added to C(ansible_local) facts. If a file is not executable it is read instead. File/results format can be JSON or INI-format. The default C(fact_path) can be specified in C(ansible.cfg) for when setup is automatically called as part of C(gather_facts). NOTE - For windows clients, the results will be added to a variable named after the local file (without extension suffix), rather than C(ansible_local). - Since Ansible 2.1, Windows hosts can use C(fact_path). Make sure that this path exists on the target host. Files in this path MUST be PowerShell scripts C(.ps1) which outputs an object. This object will be formatted by Ansible as json so the script should be outputting a raw hashtable, array, or other primitive object. type: path 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. - This module is also supported for Windows targets. extends_documentation_fragment: - action_common_attributes - action_common_attributes.facts attributes: check_mode: support: full diff_mode: support: none facts: support: full platform: platforms: posix, windows 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(community.general.facter) and M(community.general.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. - This module should be run with elevated privileges on BSD systems to gather facts like ansible_product_version. - For more information about delegated facts, please check U(https://docs.ansible.com/ansible/latest/user_guide/playbooks_delegation.html#delegating-facts). author: - "Ansible Core Team" - "Michael DeHaan" a # Display facts from all hosts and store them indexed by `hostname` at `/tmp/facts`. # ansible all -m ansible.builtin.setup --tree /tmp/facts # Display only facts regarding memory found by ansible on all hosts and output them. # ansible all -m ansible.builtin.setup -a 'filter=ansible_*_mb' # Display only facts returned by facter. # ansible all -m ansible.builtin.setup -a 'filter=facter_*' # Collect only facts returned by facter. # ansible all -m ansible.builtin.setup -a 'gather_subset=!all,facter' - name: Collect only facts returned by facter ansible.builtin.setup: gather_subset: - '!all' - '!<any valid subset>' - facter - name: Filter and return only selected facts ansible.builtin.setup: filter: - 'ansible_distribution' - 'ansible_machine_id' - 'ansible_*_mb' # Display only facts about certain interfaces. # ansible all -m ansible.builtin.setup -a 'filter=ansible_eth[0-2]' # Restrict additional gathered facts to network and virtual (includes default minimum facts) # ansible all -m ansible.builtin.setup -a 'gather_subset=network,virtual' # Collect only network and virtual (excludes default minimum facts) # ansible all -m ansible.builtin.setup -a 'gather_subset=!all,network,virtual' # Do not call puppet facter or ohai even if present. # ansible all -m ansible.builtin.setup -a 'gather_subset=!facter,!ohai' # Only collect the default minimum amount of facts: # ansible all -m ansible.builtin.setup -a 'gather_subset=!all' # Collect no facts, even the default minimum subset of facts: # ansible all -m ansible.builtin.setup -a 'gather_subset=!all,!min' # Display facts from Windows hosts with custom facts stored in C:\custom_facts. # ansible windows -m ansible.builtin.setup -a "fact_path='c:\custom_facts'" # Gathers facts for the machines in the dbservers group (a.k.a Delegating facts) - hosts: app_servers tasks: - name: Gather facts from db servers ansible.builtin.setup: delegate_to: "{{ item }}" delegate_facts: true loop: "{{ groups['dbservers'] }}" � )� AnsibleModule)�to_text)�ansible_collector�default_collectors)�CollectorNotFoundError�CycleFoundInFactDeps�UnresolvedFactDep)�PrefixFactNamespacec C s� t ttdgdddd�tdddd�tg dddd�td dd d�d �d d �} | jd }| jd }| jd }tg d��}tj}tddd�}ztj||||||d�}W n< t t t t fy� } z | j t|�d� W Y d }~n d }~0 0 |j| d�} | j| d� d S )N�allF�list�str)�default�required�type�elements� �int)r r r z/etc/ansible/facts.d�path)� gather_subset�gather_timeout�filterZ fact_pathT)Z argument_specZsupports_check_moder r r )ZapparmorZcapsZcmdlineZ date_timeZ distributionZdns�envZfips�localZlsbZpkg_mgr�platformZpythonZselinuxZ service_mgrZ ssh_pub_keys�userZansibleZansible_)Znamespace_name�prefix)�all_collector_classes� namespace� filter_specr r �minimal_gather_subset)�msg)�module)Z ansible_facts)r �dict�params� frozensetr Z collectorsr r Zget_ansible_collector� TypeErrorr r r Z fail_jsonr ZcollectZ exit_json) r% r r r" r# r r! Zfact_collector�eZ facts_dict� r+ �9/usr/lib/python3.9/site-packages/ansible/modules/setup.py�main� s: �� �� & r- �__main__N)Z __future__r r r r Z __metaclass__Z DOCUMENTATIONZEXAMPLESZmodule_utils.basicr Zansible.module_utils._textr Zansible.module_utils.factsr r Z$ansible.module_utils.facts.collectorr r r Z$ansible.module_utils.facts.namespacer r- �__name__r+ r+ r+ r, �<module> s j; .