Class: Ansible::Ruby::Modules::Junos_facts

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/junos/junos_facts.rb

Overview

Collects fact information from a remote device running the Junos operating system. By default, the module will collect basic fact information from the device to be included with the hostvars. Additional fact information can be collected based on the configured set of arguments.

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

#config_format ⇒ :xml, ...

Returns The I(config_format) argument specifies the format of the configuration when serializing output from the device. This argument is applicable only when C(config) value is present in I(gather_subset). The I(config_format) should be supported by the junos version running on device. This value is not applicable while fetching old style facts that is when C(ofacts) value is present in value if I(gather_subset) value.

Returns:

  • (:xml, :text, :set, :json, nil) —

    The I(config_format) argument specifies the format of the configuration when serializing output from the device. This argument is applicable only when C(config) value is present in I(gather_subset). The I(config_format) should be supported by the junos version running on device. This value is not applicable while fetching old style facts that is when C(ofacts) value is present in value if I(gather_subset) value.



16
 
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_facts.rb', line 16

attribute :config_format

#gather_subset ⇒ String?

Returns When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should not be collected. To maintain backward compatbility old style facts can be retrieved by explicilty adding C(ofacts) to value, this reqires junos-eznc to be installed as a prerequisite. Valid value of gather_subset are default, hardware, config, interfaces, ofacts. If C(ofacts) is present in the list it fetches the old style facts (fact keys without ‘ansible_’ prefix) and it requires junos-eznc library to be installed on control node and the device login credentials must be given in C(provider) option.

Returns:

  • (String, nil) —

    When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial C(M(!)) to specify that a specific subset should not be collected. To maintain backward compatbility old style facts can be retrieved by explicilty adding C(ofacts) to value, this reqires junos-eznc to be installed as a prerequisite. Valid value of gather_subset are default, hardware, config, interfaces, ofacts. If C(ofacts) is present in the list it fetches the old style facts (fact keys without ‘ansible_’ prefix) and it requires junos-eznc library to be installed on control node and the device login credentials must be given in C(provider) option.



12
 
# File 'lib/ansible/ruby/modules/generated/network/junos/junos_facts.rb', line 12

attribute :gather_subset