X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2Fclasses%2FMCollective%2FFacts.html;fp=doc%2Fclasses%2FMCollective%2FFacts.html;h=5171a69981dd8345f2a01c64a6ab19a859baeadf;hb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;hp=0000000000000000000000000000000000000000;hpb=8a3fe7daeecccf43dd71c59371c5005400d35101;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/classes/MCollective/Facts.html b/doc/classes/MCollective/Facts.html new file mode 100644 index 0000000..5171a69 --- /dev/null +++ b/doc/classes/MCollective/Facts.html @@ -0,0 +1,237 @@ + + + + + + Module: MCollective::Facts + + + + + + + + + + +
+ + + + + + + + + + +
ModuleMCollective::Facts
In: + + lib/mcollective/facts/base.rb + +
+ + lib/mcollective/facts.rb + +
+
+
+ + +
+ + + +
+ +
+

+This is a class that gives access to the configured fact provider such as +MCollectives::Facts::Facter that uses Reductive Labs facter +

+

+The actual provider is pluggable and configurable using the +‘factsource’ configuration option. +

+

+To develop a new factsource simply create a class under MCollective::Facts:: and provide the following +classes: +

+
+  self.get_fact(fact)
+  self.has_fact?(fact)
+
+

+You can also just inherit from MCollective::Facts::Base and provide just the +

+
+  self.get_facts
+
+

+method that should return a hash of facts. +

+ +
+ + +
+ +
+

Methods

+ +
+ []   + get_fact   + has_fact?   +
+
+ +
+ + + + +
+ +
+

Classes and Modules

+ + Class MCollective::Facts::Base
+ +
+ + + + + + + + +
+

Public Class methods

+ +
+ + +
+ + [](fact) + +
+ +
+

+Get the value of a fact +

+

[Source]

+
+
+    # File lib/mcollective/facts.rb, line 35
+35:     def self.[](fact)
+36:       PluginManager["facts_plugin"].get_fact(fact)
+37:     end
+
+
+
+
+ +
+ + +
+ + get_fact(fact) + +
+ +
+

+Get the value of a fact +

+

[Source]

+
+
+    # File lib/mcollective/facts.rb, line 30
+30:     def self.get_fact(fact)
+31:       PluginManager["facts_plugin"].get_fact(fact)
+32:     end
+
+
+
+
+ +
+ + +
+ + has_fact?(fact, value) + +
+ +
+

+True if we know of a specific fact else false +

+

[Source]

+
+
+    # File lib/mcollective/facts.rb, line 25
+25:     def self.has_fact?(fact, value)
+26:       PluginManager["facts_plugin"].get_fact(fact) == value ? true : false
+27:     end
+
+
+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file