Class: Ansible::Ruby::Modules::Setup

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/system/setup.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#fact_path ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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



19
 
# File 'lib/ansible/ruby/modules/generated/core/system/setup.rb', line 19

attribute :fact_path

#filter ⇒ String?

Returns if supplied, only return facts that match this shell-style (fnmatch) wildcard.

Returns:

  • (String, nil) —

    if supplied, only return facts that match this shell-style (fnmatch) wildcard.



15
 
# File 'lib/ansible/ruby/modules/generated/core/system/setup.rb', line 15

attribute :filter

#gather_subset ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



11
 
# File 'lib/ansible/ruby/modules/generated/core/system/setup.rb', line 11

attribute :gather_subset