Functions as a hash of ‘facts’ about your system system, such as MAC address, IP address, architecture, etc.
@example Retrieve a fact
puts Facter['operatingsystem'].value
@example Retrieve all facts
Facter.to_hash => { "kernel"=>"Linux", "uptime_days"=>0, "ipaddress"=>"10.0.0.1" }
@api public
FACTERVERSION | = | '2.5.1' |
Adds a {Facter::Util::Resolution resolution} mechanism for a named fact. This does not distinguish between adding a new fact and adding a new way to resolve a fact.
@overload add(name, options = {}, { || … }) @param name [String] the fact name @param options [Hash] optional parameters for the fact - attributes
of {Facter::Util::Fact} and {Facter::Util::Resolution} can be supplied here
@option options [Integer] :timeout set the
{Facter::Util::Resolution#timeout timeout} for this resolution
@param block [Proc] a block defining a fact resolution
@return [Facter::Util::Fact] the fact object, which includes any previously
defined resolutions
@api public
Accessor for the collection object which holds all the facts @return [Facter::Util::Collection] the collection of facts
@api private
Flushes cached values for all facts. This does not cause code to be reloaded; it only clears the cached results.
@return [void]
@api public
Removes all facts from memory. Use this when the fact code has changed on disk and needs to be reloaded.
@return [void]
@api public
Register directories to be searched for facts. The registered directories must be absolute paths or they will be ignored.
@param dirs [String] directories to search
@return [void]
@api public
Registers directories to be searched for external facts.
@param dirs [Array<String>] directories to search
@return [void]
@api public
Returns the registered search directories.
@return [Array<String>] An array of the directories searched
@api public
Returns the registered search directories.
@return [Array<String>] An array of the directories searched
@api public
Returns the running version of Facter.
@comment The intent is that software external to Facter be able to
determine the Facter version with no side-effects. The expected use is: require 'facter/version' version = Facter.version This function has the following ordering precedence. This precedence list is designed to facilitate automated packaging tasks by simply writing to the VERSION file in the same directory as this source file. 1. If a version has been explicitly assigned using the Facter.version= method, return that version. 2. If there is a VERSION file, read the contents, trim any trailing whitespace, and return that version string. 3. Return the value of the Facter::FACTERVERSION constant hard-coded into the source code. If there is no VERSION file, the method must return the version string of the nearest parent version that is an officially released version. That is to say, if a branch named 3.1.x contains 25 patches on top of the most recent official release of 3.1.1, then the version method must return the string "3.1.1" if no "VERSION" file is present. By design the version identifier is _not_ intended to vary during the life of a process. There is no guarantee provided that writing to the VERSION file while a Puppet process is running will cause the version string to be updated. On the contrary, the contents of the VERSION are cached to reduce filesystem accesses. The VERSION file is intended to be used by package maintainers who may be applying patches or otherwise changing the software version in a manner that warrants a different software version identifier. The VERSION file is intended to be managed and owned by the release process and packaging related tasks, and as such should not reside in version control. The FACTERVERSION constant is intended to be version controlled in history. Ideally, this behavior will allow package maintainers to precisely specify the version of the software they're packaging as in the following example: $ git describe > lib/facter/VERSION $ ruby -r facter -e 'puts Facter.version' 1.6.14-6-g66f2c99
@api public
@return [String] containing the facter version, e.g. "1.6.14"