1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Module: MCollective::Facts</title>
10 <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
12 <script src="../js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="../js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="../js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="../js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
25 <div id="file-metadata">
26 <div id="file-list-section" class="section">
27 <h3 class="section-header">In Files</h3>
28 <div class="section-body">
31 <li><a href="../lib/mcollective/facts/base_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/facts/base.rb">lib/mcollective/facts/base.rb</a></li>
34 <li><a href="../lib/mcollective/facts_rb.html?TB_iframe=true&height=550&width=785"
35 class="thickbox" title="lib/mcollective/facts.rb">lib/mcollective/facts.rb</a></li>
44 <div id="class-metadata">
49 <!-- Namespace Contents -->
51 <div id="namespace-list-section" class="section">
52 <h3 class="section-header">Namespace</h3>
53 <ul class="link-list">
55 <li><span class="type">CLASS</span> <a href="Facts/Base.html">MCollective::Facts::Base</a></li>
61 <!-- Method Quickref -->
63 <div id="method-list-section" class="section">
64 <h3 class="section-header">Methods</h3>
65 <ul class="link-list">
67 <li><a href="#M000484">::[]</a></li>
69 <li><a href="#M000483">::get_fact</a></li>
71 <li><a href="#M000482">::has_fact?</a></li>
77 <!-- Included Modules -->
81 <div id="project-metadata">
84 <div id="fileindex-section" class="section project-section">
85 <h3 class="section-header">Files</h3>
88 <li class="file"><a href="../COPYING.html">COPYING</a></li>
90 <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
92 <li class="file"><a href="../README.html">README</a></li>
94 <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
96 <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
98 <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
100 <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
102 <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
104 <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
106 <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
108 <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
110 <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
112 <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
114 <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
116 <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
118 <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
120 <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
122 <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
124 <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
126 <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
132 <div id="classindex-section" class="section project-section">
133 <h3 class="section-header">Class Index
134 <span class="search-toggle"><img src="../images/find.png"
135 height="16" width="16" alt="[+]"
136 title="show/hide quicksearch" /></span></h3>
137 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
139 <legend>Quicksearch</legend>
140 <input type="text" name="quicksearch" value=""
141 class="quicksearch-field" />
145 <ul class="link-list">
147 <li><a href="../MCollective.html">MCollective</a></li>
149 <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
151 <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
153 <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
155 <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
157 <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
159 <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
161 <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
163 <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
165 <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
167 <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
169 <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
171 <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
173 <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
175 <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
177 <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
179 <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
181 <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
183 <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
185 <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
187 <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
189 <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
191 <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
193 <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
195 <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
197 <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
199 <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
201 <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
203 <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
205 <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
207 <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
209 <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
211 <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
213 <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
215 <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
217 <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
219 <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
221 <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
223 <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
225 <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
227 <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
229 <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
231 <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
233 <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
235 <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
237 <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
239 <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
241 <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
243 <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
245 <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
247 <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
249 <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
251 <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
253 <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
255 <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
257 <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
259 <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
261 <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
263 <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
265 <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
267 <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
269 <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
271 <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
273 <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
275 <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
277 <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
279 <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
281 <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
283 <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
285 <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
287 <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
289 <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
291 <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
293 <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
295 <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
297 <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
299 <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
301 <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
303 <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
305 <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
307 <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
309 <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
311 <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
313 <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
315 <li><a href="../Array.html">Array</a></li>
317 <li><a href="../Dir.html">Dir</a></li>
319 <li><a href="../Object.html">Object</a></li>
321 <li><a href="../String.html">String</a></li>
323 <li><a href="../Symbol.html">Symbol</a></li>
326 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
333 <div id="documentation">
334 <h1 class="module">MCollective::Facts</h1>
336 <div id="description">
338 This is a class that gives access to the configured fact provider such as
339 MCollectives::Facts::Facter that uses Reductive Labs facter
342 The actual provider is pluggable and configurable using the
343 ‘factsource’ configuration option.
346 To develop a new factsource simply create a class under
347 MCollective::Facts:: and provide the following classes:
354 You can also just inherit from <a
355 href="Facts/Base.html">MCollective::Facts::Base</a> and provide just the
361 method that should return a hash of facts.
374 <div id="public-class-method-details" class="method-section section">
375 <h3 class="section-header">Public Class Methods</h3>
378 <div id="--method" class="method-detail ">
379 <a name="M000484"></a>
381 <div class="method-heading">
383 <span class="method-name">[]</span><span
384 class="method-args">(fact)</span>
385 <span class="method-click-advice">click to toggle source</span>
389 <div class="method-description">
392 Get the value of a fact
397 <div class="method-source-code"
400 <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 35</span>
401 35: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">fact</span>)
402 36: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
403 37: <span class="ruby-keyword kw">end</span></pre>
412 <div id="get-fact-method" class="method-detail ">
413 <a name="M000483"></a>
415 <div class="method-heading">
417 <span class="method-name">get_fact</span><span
418 class="method-args">(fact)</span>
419 <span class="method-click-advice">click to toggle source</span>
423 <div class="method-description">
426 Get the value of a fact
431 <div class="method-source-code"
432 id="get-fact-source">
434 <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 30</span>
435 30: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
436 31: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
437 32: <span class="ruby-keyword kw">end</span></pre>
446 <div id="has-fact--method" class="method-detail ">
447 <a name="M000482"></a>
449 <div class="method-heading">
451 <span class="method-name">has_fact?</span><span
452 class="method-args">(fact, value)</span>
453 <span class="method-click-advice">click to toggle source</span>
457 <div class="method-description">
460 True if we know of a specific fact else false
465 <div class="method-source-code"
466 id="has-fact--source">
468 <span class="ruby-comment cmt"># File lib/mcollective/facts.rb, line 25</span>
469 25: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>)
470 26: <span class="ruby-constant">PluginManager</span>[<span class="ruby-value str">"facts_plugin"</span>].<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">value</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">false</span>
471 27: <span class="ruby-keyword kw">end</span></pre>
486 <div id="rdoc-debugging-section-dump" class="debugging-section">
488 <p>Disabled; run with --debug to generate this.</p>
492 <div id="validator-badges">
493 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
494 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
495 Rdoc Generator</a> 1.1.6</small>.</p>