1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8 <title>Module: MCollective</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Module</strong></td>
53 <td class="class-name-in-header">MCollective</td>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../files/lib/mcollective_rb.html">
62 <a href="../files/lib/mcollective/application_rb.html">
63 lib/mcollective/application.rb
66 <a href="../files/lib/mcollective/optionparser_rb.html">
67 lib/mcollective/optionparser.rb
70 <a href="../files/lib/mcollective/pluginpackager_rb.html">
71 lib/mcollective/pluginpackager.rb
74 <a href="../files/lib/mcollective/matcher/scanner_rb.html">
75 lib/mcollective/matcher/scanner.rb
78 <a href="../files/lib/mcollective/matcher/parser_rb.html">
79 lib/mcollective/matcher/parser.rb
82 <a href="../files/lib/mcollective/message_rb.html">
83 lib/mcollective/message.rb
86 <a href="../files/lib/mcollective/matcher_rb.html">
87 lib/mcollective/matcher.rb
90 <a href="../files/lib/mcollective/runner_rb.html">
91 lib/mcollective/runner.rb
94 <a href="../files/lib/mcollective/pluginmanager_rb.html">
95 lib/mcollective/pluginmanager.rb
98 <a href="../files/lib/mcollective/security_rb.html">
99 lib/mcollective/security.rb
102 <a href="../files/lib/mcollective/connector_rb.html">
103 lib/mcollective/connector.rb
106 <a href="../files/lib/mcollective/pluginpackager/standard_definition_rb.html">
107 lib/mcollective/pluginpackager/standard_definition.rb
110 <a href="../files/lib/mcollective/pluginpackager/agent_definition_rb.html">
111 lib/mcollective/pluginpackager/agent_definition.rb
114 <a href="../files/lib/mcollective/applications_rb.html">
115 lib/mcollective/applications.rb
118 <a href="../files/lib/mcollective/logger_rb.html">
119 lib/mcollective/logger.rb
122 <a href="../files/lib/mcollective/agents_rb.html">
123 lib/mcollective/agents.rb
126 <a href="../files/lib/mcollective/config_rb.html">
127 lib/mcollective/config.rb
130 <a href="../files/lib/mcollective/log_rb.html">
131 lib/mcollective/log.rb
134 <a href="../files/lib/mcollective/agent_rb.html">
135 lib/mcollective/agent.rb
138 <a href="../files/lib/mcollective/aggregate_rb.html">
139 lib/mcollective/aggregate.rb
142 <a href="../files/lib/mcollective/discovery_rb.html">
143 lib/mcollective/discovery.rb
146 <a href="../files/lib/mcollective/registration/base_rb.html">
147 lib/mcollective/registration/base.rb
150 <a href="../files/lib/mcollective/registration_rb.html">
151 lib/mcollective/registration.rb
154 <a href="../files/lib/mcollective/logger/console_logger_rb.html">
155 lib/mcollective/logger/console_logger.rb
158 <a href="../files/lib/mcollective/logger/base_rb.html">
159 lib/mcollective/logger/base.rb
162 <a href="../files/lib/mcollective/logger/syslog_logger_rb.html">
163 lib/mcollective/logger/syslog_logger.rb
166 <a href="../files/lib/mcollective/logger/file_logger_rb.html">
167 lib/mcollective/logger/file_logger.rb
170 <a href="../files/lib/mcollective/data/base_rb.html">
171 lib/mcollective/data/base.rb
174 <a href="../files/lib/mcollective/data/result_rb.html">
175 lib/mcollective/data/result.rb
178 <a href="../files/lib/mcollective/ssl_rb.html">
179 lib/mcollective/ssl.rb
182 <a href="../files/lib/mcollective/runnerstats_rb.html">
183 lib/mcollective/runnerstats.rb
186 <a href="../files/lib/mcollective/translatable_rb.html">
187 lib/mcollective/translatable.rb
190 <a href="../files/lib/mcollective/generators/base_rb.html">
191 lib/mcollective/generators/base.rb
194 <a href="../files/lib/mcollective/generators/data_generator_rb.html">
195 lib/mcollective/generators/data_generator.rb
198 <a href="../files/lib/mcollective/generators/agent_generator_rb.html">
199 lib/mcollective/generators/agent_generator.rb
202 <a href="../files/lib/mcollective/aggregate/base_rb.html">
203 lib/mcollective/aggregate/base.rb
206 <a href="../files/lib/mcollective/aggregate/result/base_rb.html">
207 lib/mcollective/aggregate/result/base.rb
210 <a href="../files/lib/mcollective/aggregate/result/collection_result_rb.html">
211 lib/mcollective/aggregate/result/collection_result.rb
214 <a href="../files/lib/mcollective/aggregate/result/numeric_result_rb.html">
215 lib/mcollective/aggregate/result/numeric_result.rb
218 <a href="../files/lib/mcollective/aggregate/result_rb.html">
219 lib/mcollective/aggregate/result.rb
222 <a href="../files/lib/mcollective/facts/base_rb.html">
223 lib/mcollective/facts/base.rb
226 <a href="../files/lib/mcollective/ddl/discoveryddl_rb.html">
227 lib/mcollective/ddl/discoveryddl.rb
230 <a href="../files/lib/mcollective/ddl/agentddl_rb.html">
231 lib/mcollective/ddl/agentddl.rb
234 <a href="../files/lib/mcollective/ddl/validatorddl_rb.html">
235 lib/mcollective/ddl/validatorddl.rb
238 <a href="../files/lib/mcollective/ddl/base_rb.html">
239 lib/mcollective/ddl/base.rb
242 <a href="../files/lib/mcollective/ddl/dataddl_rb.html">
243 lib/mcollective/ddl/dataddl.rb
246 <a href="../files/lib/mcollective/util_rb.html">
247 lib/mcollective/util.rb
250 <a href="../files/lib/mcollective/connector/base_rb.html">
251 lib/mcollective/connector/base.rb
254 <a href="../files/lib/mcollective/rpc_rb.html">
255 lib/mcollective/rpc.rb
258 <a href="../files/lib/mcollective/validator_rb.html">
259 lib/mcollective/validator.rb
262 <a href="../files/lib/mcollective/cache_rb.html">
263 lib/mcollective/cache.rb
266 <a href="../files/lib/mcollective/unix_daemon_rb.html">
267 lib/mcollective/unix_daemon.rb
270 <a href="../files/lib/mcollective/windows_daemon_rb.html">
271 lib/mcollective/windows_daemon.rb
274 <a href="../files/lib/mcollective/security/base_rb.html">
275 lib/mcollective/security/base.rb
278 <a href="../files/lib/mcollective/shell_rb.html">
279 lib/mcollective/shell.rb
282 <a href="../files/lib/mcollective/ddl_rb.html">
283 lib/mcollective/ddl.rb
286 <a href="../files/lib/mcollective/rpc/actionrunner_rb.html">
287 lib/mcollective/rpc/actionrunner.rb
290 <a href="../files/lib/mcollective/rpc/reply_rb.html">
291 lib/mcollective/rpc/reply.rb
294 <a href="../files/lib/mcollective/rpc/progress_rb.html">
295 lib/mcollective/rpc/progress.rb
298 <a href="../files/lib/mcollective/rpc/agent_rb.html">
299 lib/mcollective/rpc/agent.rb
302 <a href="../files/lib/mcollective/rpc/request_rb.html">
303 lib/mcollective/rpc/request.rb
306 <a href="../files/lib/mcollective/rpc/audit_rb.html">
307 lib/mcollective/rpc/audit.rb
310 <a href="../files/lib/mcollective/rpc/stats_rb.html">
311 lib/mcollective/rpc/stats.rb
314 <a href="../files/lib/mcollective/rpc/result_rb.html">
315 lib/mcollective/rpc/result.rb
318 <a href="../files/lib/mcollective/rpc/client_rb.html">
319 lib/mcollective/rpc/client.rb
322 <a href="../files/lib/mcollective/rpc/helpers_rb.html">
323 lib/mcollective/rpc/helpers.rb
326 <a href="../files/lib/mcollective/facts_rb.html">
327 lib/mcollective/facts.rb
330 <a href="../files/lib/mcollective/data_rb.html">
331 lib/mcollective/data.rb
334 <a href="../files/lib/mcollective/client_rb.html">
335 lib/mcollective/client.rb
338 <a href="../files/lib/mcollective/exception_rb.html">
339 lib/mcollective/exception.rb
342 <a href="../files/lib/mcollective/generators_rb.html">
343 lib/mcollective/generators.rb
351 <!-- banner header -->
353 <div id="bodyContent">
357 <div id="contextContent">
359 <div id="description">
360 <h2>The Marionette Collective</h2>
362 Framework to build and run Systems Administration agents running on a
363 publish/subscribe middleware system. The system allows you to treat your
364 network as the only true source of the state of your platform via discovery
365 agents and allow you to run agents matching discovery criteria.
368 For an overview of the idea behind this and what it enables please see:
371 http://www.devco.net/archives/2009/10/18/middleware_for_systems_administration.php
379 <div id="method-list">
380 <h3 class="section-bar">Methods</h3>
382 <div class="name-list">
383 <a href="#M000015">version</a>
394 <div id="class-list">
395 <h3 class="section-bar">Classes and Modules</h3>
397 Module <a href="MCollective/Agent.html" class="link">MCollective::Agent</a><br />
398 Module <a href="MCollective/Cache.html" class="link">MCollective::Cache</a><br />
399 Module <a href="MCollective/Connector.html" class="link">MCollective::Connector</a><br />
400 Module <a href="MCollective/DDL.html" class="link">MCollective::DDL</a><br />
401 Module <a href="MCollective/Data.html" class="link">MCollective::Data</a><br />
402 Module <a href="MCollective/Facts.html" class="link">MCollective::Facts</a><br />
403 Module <a href="MCollective/Generators.html" class="link">MCollective::Generators</a><br />
404 Module <a href="MCollective/Logger.html" class="link">MCollective::Logger</a><br />
405 Module <a href="MCollective/Matcher.html" class="link">MCollective::Matcher</a><br />
406 Module <a href="MCollective/PluginManager.html" class="link">MCollective::PluginManager</a><br />
407 Module <a href="MCollective/PluginPackager.html" class="link">MCollective::PluginPackager</a><br />
408 Module <a href="MCollective/RPC.html" class="link">MCollective::RPC</a><br />
409 Module <a href="MCollective/Registration.html" class="link">MCollective::Registration</a><br />
410 Module <a href="MCollective/Security.html" class="link">MCollective::Security</a><br />
411 Module <a href="MCollective/Translatable.html" class="link">MCollective::Translatable</a><br />
412 Module <a href="MCollective/Util.html" class="link">MCollective::Util</a><br />
413 Module <a href="MCollective/Validator.html" class="link">MCollective::Validator</a><br />
414 Class <a href="MCollective/Agents.html" class="link">MCollective::Agents</a><br />
415 Class <a href="MCollective/Aggregate.html" class="link">MCollective::Aggregate</a><br />
416 Class <a href="MCollective/Application.html" class="link">MCollective::Application</a><br />
417 Class <a href="MCollective/Applications.html" class="link">MCollective::Applications</a><br />
418 Class <a href="MCollective/Client.html" class="link">MCollective::Client</a><br />
419 Class <a href="MCollective/CodedError.html" class="link">MCollective::CodedError</a><br />
420 Class <a href="MCollective/Config.html" class="link">MCollective::Config</a><br />
421 Class <a href="MCollective/DDLValidationError.html" class="link">MCollective::DDLValidationError</a><br />
422 Class <a href="MCollective/Discovery.html" class="link">MCollective::Discovery</a><br />
423 Class <a href="MCollective/InvalidRPCData.html" class="link">MCollective::InvalidRPCData</a><br />
424 Class <a href="MCollective/Log.html" class="link">MCollective::Log</a><br />
425 Class <a href="MCollective/Message.html" class="link">MCollective::Message</a><br />
426 Class <a href="MCollective/MissingRPCData.html" class="link">MCollective::MissingRPCData</a><br />
427 Class <a href="MCollective/MsgDoesNotMatchRequestID.html" class="link">MCollective::MsgDoesNotMatchRequestID</a><br />
428 Class <a href="MCollective/MsgTTLExpired.html" class="link">MCollective::MsgTTLExpired</a><br />
429 Class <a href="MCollective/NotTargettedAtUs.html" class="link">MCollective::NotTargettedAtUs</a><br />
430 Class <a href="MCollective/Optionparser.html" class="link">MCollective::Optionparser</a><br />
431 Class <a href="MCollective/RPCAborted.html" class="link">MCollective::RPCAborted</a><br />
432 Class <a href="MCollective/RPCError.html" class="link">MCollective::RPCError</a><br />
433 Class <a href="MCollective/Runner.html" class="link">MCollective::Runner</a><br />
434 Class <a href="MCollective/RunnerStats.html" class="link">MCollective::RunnerStats</a><br />
435 Class <a href="MCollective/SSL.html" class="link">MCollective::SSL</a><br />
436 Class <a href="MCollective/SecurityValidationFailed.html" class="link">MCollective::SecurityValidationFailed</a><br />
437 Class <a href="MCollective/Shell.html" class="link">MCollective::Shell</a><br />
438 Class <a href="MCollective/UnixDaemon.html" class="link">MCollective::UnixDaemon</a><br />
439 Class <a href="MCollective/UnknownRPCAction.html" class="link">MCollective::UnknownRPCAction</a><br />
440 Class <a href="MCollective/UnknownRPCError.html" class="link">MCollective::UnknownRPCError</a><br />
441 Class <a href="MCollective/ValidatorError.html" class="link">MCollective::ValidatorError</a><br />
442 Class <a href="MCollective/WindowsDaemon.html" class="link">MCollective::WindowsDaemon</a><br />
446 <div id="constants-list">
447 <h3 class="section-bar">Constants</h3>
449 <div class="name-list">
450 <table summary="Constants">
451 <tr class="top-aligned-row context-row">
452 <td class="context-item-name">VERSION</td>
454 <td class="context-item-value">"@DEVELOPMENT_VERSION@"</td>
465 <!-- if method_list -->
467 <h3 class="section-bar">Public Class methods</h3>
469 <div id="method-M000015" class="method-detail">
470 <a name="M000015"></a>
472 <div class="method-heading">
473 <a href="#M000015" class="method-signature">
474 <span class="method-name">version</span><span class="method-args">()</span>
478 <div class="method-description">
479 <p><a class="source-toggle" href="#"
480 onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
481 <div class="method-source-code" id="M000015-source">
483 <span class="ruby-comment cmt"># File lib/mcollective.rb, line 65</span>
484 65: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
485 66: <span class="ruby-constant">VERSION</span>
486 67: <span class="ruby-keyword kw">end</span>
499 <div id="validator-badges">
500 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>