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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/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. This module is also supported for Windows targets.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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 (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. 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 (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. Check notes for Windows options. (from 2.1 on) File/results format can be json or ini-format



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

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.



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

attribute :filter

#gather_subset ⇒ String?

Returns if supplied, restrict the additional facts collected to the given subset. Possible values: C(all), C(min), C(hardware), C(network), C(virtual), C(ohai), and C(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: 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.

Returns:

  • (String, nil) —

    if supplied, restrict the additional facts collected to the given subset. Possible values: C(all), C(min), C(hardware), C(network), C(virtual), C(ohai), and C(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: 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.



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

attribute :gather_subset

#gather_timeout ⇒ Integer?

Returns Set the default timeout in seconds for individual fact gathering.

Returns:

  • (Integer, nil) —

    Set the default timeout in seconds for individual fact gathering



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

attribute :gather_timeout