Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / MCollective.html
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">
5 <head>
6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
8         <title>Module: MCollective</title>
9
10         <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
11
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>
20
21 </head>
22 <body class="module">
23
24         <div id="metadata">
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">
29                                         <ul>
30                                         
31                                                 <li><a href="./lib/mcollective_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32                                                         class="thickbox" title="lib/mcollective.rb">lib/mcollective.rb</a></li>
33                                         
34                                                 <li><a href="./lib/mcollective/application_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
35                                                         class="thickbox" title="lib/mcollective/application.rb">lib/mcollective/application.rb</a></li>
36                                         
37                                                 <li><a href="./lib/mcollective/optionparser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
38                                                         class="thickbox" title="lib/mcollective/optionparser.rb">lib/mcollective/optionparser.rb</a></li>
39                                         
40                                                 <li><a href="./lib/mcollective/pluginpackager_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
41                                                         class="thickbox" title="lib/mcollective/pluginpackager.rb">lib/mcollective/pluginpackager.rb</a></li>
42                                         
43                                                 <li><a href="./lib/mcollective/matcher/scanner_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
44                                                         class="thickbox" title="lib/mcollective/matcher/scanner.rb">lib/mcollective/matcher/scanner.rb</a></li>
45                                         
46                                                 <li><a href="./lib/mcollective/matcher/parser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
47                                                         class="thickbox" title="lib/mcollective/matcher/parser.rb">lib/mcollective/matcher/parser.rb</a></li>
48                                         
49                                                 <li><a href="./lib/mcollective/matcher_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
50                                                         class="thickbox" title="lib/mcollective/matcher.rb">lib/mcollective/matcher.rb</a></li>
51                                         
52                                                 <li><a href="./lib/mcollective/message_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
53                                                         class="thickbox" title="lib/mcollective/message.rb">lib/mcollective/message.rb</a></li>
54                                         
55                                                 <li><a href="./lib/mcollective/runner_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
56                                                         class="thickbox" title="lib/mcollective/runner.rb">lib/mcollective/runner.rb</a></li>
57                                         
58                                                 <li><a href="./lib/mcollective/pluginmanager_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
59                                                         class="thickbox" title="lib/mcollective/pluginmanager.rb">lib/mcollective/pluginmanager.rb</a></li>
60                                         
61                                                 <li><a href="./lib/mcollective/security_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
62                                                         class="thickbox" title="lib/mcollective/security.rb">lib/mcollective/security.rb</a></li>
63                                         
64                                                 <li><a href="./lib/mcollective/connector_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
65                                                         class="thickbox" title="lib/mcollective/connector.rb">lib/mcollective/connector.rb</a></li>
66                                         
67                                                 <li><a href="./lib/mcollective/pluginpackager/standard_definition_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
68                                                         class="thickbox" title="lib/mcollective/pluginpackager/standard_definition.rb">lib/mcollective/pluginpackager/standard_definition.rb</a></li>
69                                         
70                                                 <li><a href="./lib/mcollective/pluginpackager/agent_definition_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
71                                                         class="thickbox" title="lib/mcollective/pluginpackager/agent_definition.rb">lib/mcollective/pluginpackager/agent_definition.rb</a></li>
72                                         
73                                                 <li><a href="./lib/mcollective/applications_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
74                                                         class="thickbox" title="lib/mcollective/applications.rb">lib/mcollective/applications.rb</a></li>
75                                         
76                                                 <li><a href="./lib/mcollective/logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
77                                                         class="thickbox" title="lib/mcollective/logger.rb">lib/mcollective/logger.rb</a></li>
78                                         
79                                                 <li><a href="./lib/mcollective/agents_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
80                                                         class="thickbox" title="lib/mcollective/agents.rb">lib/mcollective/agents.rb</a></li>
81                                         
82                                                 <li><a href="./lib/mcollective/config_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
83                                                         class="thickbox" title="lib/mcollective/config.rb">lib/mcollective/config.rb</a></li>
84                                         
85                                                 <li><a href="./lib/mcollective/log_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
86                                                         class="thickbox" title="lib/mcollective/log.rb">lib/mcollective/log.rb</a></li>
87                                         
88                                                 <li><a href="./lib/mcollective/agent_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
89                                                         class="thickbox" title="lib/mcollective/agent.rb">lib/mcollective/agent.rb</a></li>
90                                         
91                                                 <li><a href="./lib/mcollective/aggregate_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
92                                                         class="thickbox" title="lib/mcollective/aggregate.rb">lib/mcollective/aggregate.rb</a></li>
93                                         
94                                                 <li><a href="./lib/mcollective/discovery_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
95                                                         class="thickbox" title="lib/mcollective/discovery.rb">lib/mcollective/discovery.rb</a></li>
96                                         
97                                                 <li><a href="./lib/mcollective/registration/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
98                                                         class="thickbox" title="lib/mcollective/registration/base.rb">lib/mcollective/registration/base.rb</a></li>
99                                         
100                                                 <li><a href="./lib/mcollective/registration_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
101                                                         class="thickbox" title="lib/mcollective/registration.rb">lib/mcollective/registration.rb</a></li>
102                                         
103                                                 <li><a href="./lib/mcollective/logger/console_logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
104                                                         class="thickbox" title="lib/mcollective/logger/console_logger.rb">lib/mcollective/logger/console_logger.rb</a></li>
105                                         
106                                                 <li><a href="./lib/mcollective/logger/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
107                                                         class="thickbox" title="lib/mcollective/logger/base.rb">lib/mcollective/logger/base.rb</a></li>
108                                         
109                                                 <li><a href="./lib/mcollective/logger/syslog_logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
110                                                         class="thickbox" title="lib/mcollective/logger/syslog_logger.rb">lib/mcollective/logger/syslog_logger.rb</a></li>
111                                         
112                                                 <li><a href="./lib/mcollective/logger/file_logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
113                                                         class="thickbox" title="lib/mcollective/logger/file_logger.rb">lib/mcollective/logger/file_logger.rb</a></li>
114                                         
115                                                 <li><a href="./lib/mcollective/data/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
116                                                         class="thickbox" title="lib/mcollective/data/base.rb">lib/mcollective/data/base.rb</a></li>
117                                         
118                                                 <li><a href="./lib/mcollective/data/result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
119                                                         class="thickbox" title="lib/mcollective/data/result.rb">lib/mcollective/data/result.rb</a></li>
120                                         
121                                                 <li><a href="./lib/mcollective/ssl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
122                                                         class="thickbox" title="lib/mcollective/ssl.rb">lib/mcollective/ssl.rb</a></li>
123                                         
124                                                 <li><a href="./lib/mcollective/runnerstats_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
125                                                         class="thickbox" title="lib/mcollective/runnerstats.rb">lib/mcollective/runnerstats.rb</a></li>
126                                         
127                                                 <li><a href="./lib/mcollective/translatable_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
128                                                         class="thickbox" title="lib/mcollective/translatable.rb">lib/mcollective/translatable.rb</a></li>
129                                         
130                                                 <li><a href="./lib/mcollective/generators/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
131                                                         class="thickbox" title="lib/mcollective/generators/base.rb">lib/mcollective/generators/base.rb</a></li>
132                                         
133                                                 <li><a href="./lib/mcollective/generators/data_generator_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
134                                                         class="thickbox" title="lib/mcollective/generators/data_generator.rb">lib/mcollective/generators/data_generator.rb</a></li>
135                                         
136                                                 <li><a href="./lib/mcollective/generators/agent_generator_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
137                                                         class="thickbox" title="lib/mcollective/generators/agent_generator.rb">lib/mcollective/generators/agent_generator.rb</a></li>
138                                         
139                                                 <li><a href="./lib/mcollective/aggregate/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
140                                                         class="thickbox" title="lib/mcollective/aggregate/base.rb">lib/mcollective/aggregate/base.rb</a></li>
141                                         
142                                                 <li><a href="./lib/mcollective/aggregate/result/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
143                                                         class="thickbox" title="lib/mcollective/aggregate/result/base.rb">lib/mcollective/aggregate/result/base.rb</a></li>
144                                         
145                                                 <li><a href="./lib/mcollective/aggregate/result/collection_result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
146                                                         class="thickbox" title="lib/mcollective/aggregate/result/collection_result.rb">lib/mcollective/aggregate/result/collection_result.rb</a></li>
147                                         
148                                                 <li><a href="./lib/mcollective/aggregate/result/numeric_result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
149                                                         class="thickbox" title="lib/mcollective/aggregate/result/numeric_result.rb">lib/mcollective/aggregate/result/numeric_result.rb</a></li>
150                                         
151                                                 <li><a href="./lib/mcollective/aggregate/result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
152                                                         class="thickbox" title="lib/mcollective/aggregate/result.rb">lib/mcollective/aggregate/result.rb</a></li>
153                                         
154                                                 <li><a href="./lib/mcollective/ddl/discoveryddl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
155                                                         class="thickbox" title="lib/mcollective/ddl/discoveryddl.rb">lib/mcollective/ddl/discoveryddl.rb</a></li>
156                                         
157                                                 <li><a href="./lib/mcollective/facts/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
158                                                         class="thickbox" title="lib/mcollective/facts/base.rb">lib/mcollective/facts/base.rb</a></li>
159                                         
160                                                 <li><a href="./lib/mcollective/ddl/validatorddl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
161                                                         class="thickbox" title="lib/mcollective/ddl/validatorddl.rb">lib/mcollective/ddl/validatorddl.rb</a></li>
162                                         
163                                                 <li><a href="./lib/mcollective/ddl/agentddl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
164                                                         class="thickbox" title="lib/mcollective/ddl/agentddl.rb">lib/mcollective/ddl/agentddl.rb</a></li>
165                                         
166                                                 <li><a href="./lib/mcollective/ddl/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
167                                                         class="thickbox" title="lib/mcollective/ddl/base.rb">lib/mcollective/ddl/base.rb</a></li>
168                                         
169                                                 <li><a href="./lib/mcollective/ddl/dataddl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
170                                                         class="thickbox" title="lib/mcollective/ddl/dataddl.rb">lib/mcollective/ddl/dataddl.rb</a></li>
171                                         
172                                                 <li><a href="./lib/mcollective/connector/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
173                                                         class="thickbox" title="lib/mcollective/connector/base.rb">lib/mcollective/connector/base.rb</a></li>
174                                         
175                                                 <li><a href="./lib/mcollective/util_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
176                                                         class="thickbox" title="lib/mcollective/util.rb">lib/mcollective/util.rb</a></li>
177                                         
178                                                 <li><a href="./lib/mcollective/rpc_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
179                                                         class="thickbox" title="lib/mcollective/rpc.rb">lib/mcollective/rpc.rb</a></li>
180                                         
181                                                 <li><a href="./lib/mcollective/validator_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
182                                                         class="thickbox" title="lib/mcollective/validator.rb">lib/mcollective/validator.rb</a></li>
183                                         
184                                                 <li><a href="./lib/mcollective/cache_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
185                                                         class="thickbox" title="lib/mcollective/cache.rb">lib/mcollective/cache.rb</a></li>
186                                         
187                                                 <li><a href="./lib/mcollective/unix_daemon_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
188                                                         class="thickbox" title="lib/mcollective/unix_daemon.rb">lib/mcollective/unix_daemon.rb</a></li>
189                                         
190                                                 <li><a href="./lib/mcollective/windows_daemon_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
191                                                         class="thickbox" title="lib/mcollective/windows_daemon.rb">lib/mcollective/windows_daemon.rb</a></li>
192                                         
193                                                 <li><a href="./lib/mcollective/security/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
194                                                         class="thickbox" title="lib/mcollective/security/base.rb">lib/mcollective/security/base.rb</a></li>
195                                         
196                                                 <li><a href="./lib/mcollective/shell_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
197                                                         class="thickbox" title="lib/mcollective/shell.rb">lib/mcollective/shell.rb</a></li>
198                                         
199                                                 <li><a href="./lib/mcollective/ddl_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
200                                                         class="thickbox" title="lib/mcollective/ddl.rb">lib/mcollective/ddl.rb</a></li>
201                                         
202                                                 <li><a href="./lib/mcollective/rpc/actionrunner_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
203                                                         class="thickbox" title="lib/mcollective/rpc/actionrunner.rb">lib/mcollective/rpc/actionrunner.rb</a></li>
204                                         
205                                                 <li><a href="./lib/mcollective/rpc/reply_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
206                                                         class="thickbox" title="lib/mcollective/rpc/reply.rb">lib/mcollective/rpc/reply.rb</a></li>
207                                         
208                                                 <li><a href="./lib/mcollective/rpc/progress_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
209                                                         class="thickbox" title="lib/mcollective/rpc/progress.rb">lib/mcollective/rpc/progress.rb</a></li>
210                                         
211                                                 <li><a href="./lib/mcollective/rpc/agent_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
212                                                         class="thickbox" title="lib/mcollective/rpc/agent.rb">lib/mcollective/rpc/agent.rb</a></li>
213                                         
214                                                 <li><a href="./lib/mcollective/rpc/request_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
215                                                         class="thickbox" title="lib/mcollective/rpc/request.rb">lib/mcollective/rpc/request.rb</a></li>
216                                         
217                                                 <li><a href="./lib/mcollective/rpc/audit_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
218                                                         class="thickbox" title="lib/mcollective/rpc/audit.rb">lib/mcollective/rpc/audit.rb</a></li>
219                                         
220                                                 <li><a href="./lib/mcollective/rpc/stats_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
221                                                         class="thickbox" title="lib/mcollective/rpc/stats.rb">lib/mcollective/rpc/stats.rb</a></li>
222                                         
223                                                 <li><a href="./lib/mcollective/rpc/result_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
224                                                         class="thickbox" title="lib/mcollective/rpc/result.rb">lib/mcollective/rpc/result.rb</a></li>
225                                         
226                                                 <li><a href="./lib/mcollective/rpc/helpers_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
227                                                         class="thickbox" title="lib/mcollective/rpc/helpers.rb">lib/mcollective/rpc/helpers.rb</a></li>
228                                         
229                                                 <li><a href="./lib/mcollective/rpc/client_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
230                                                         class="thickbox" title="lib/mcollective/rpc/client.rb">lib/mcollective/rpc/client.rb</a></li>
231                                         
232                                                 <li><a href="./lib/mcollective/facts_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
233                                                         class="thickbox" title="lib/mcollective/facts.rb">lib/mcollective/facts.rb</a></li>
234                                         
235                                                 <li><a href="./lib/mcollective/data_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
236                                                         class="thickbox" title="lib/mcollective/data.rb">lib/mcollective/data.rb</a></li>
237                                         
238                                                 <li><a href="./lib/mcollective/client_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
239                                                         class="thickbox" title="lib/mcollective/client.rb">lib/mcollective/client.rb</a></li>
240                                         
241                                                 <li><a href="./lib/mcollective/exception_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
242                                                         class="thickbox" title="lib/mcollective/exception.rb">lib/mcollective/exception.rb</a></li>
243                                         
244                                                 <li><a href="./lib/mcollective/generators_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
245                                                         class="thickbox" title="lib/mcollective/generators.rb">lib/mcollective/generators.rb</a></li>
246                                         
247                                         </ul>
248                                 </div>
249                         </div>
250
251                         
252                 </div>
253
254                 <div id="class-metadata">
255
256                         <!-- Parent Class -->
257                         
258
259                         <!-- Namespace Contents -->
260                         
261                         <div id="namespace-list-section" class="section">
262                                 <h3 class="section-header">Namespace</h3>
263                                 <ul class="link-list">
264                                         
265                                         <li><span class="type">MODULE</span> <a href="MCollective/Agent.html">MCollective::Agent</a></li>
266                                         
267                                         <li><span class="type">MODULE</span> <a href="MCollective/Cache.html">MCollective::Cache</a></li>
268                                         
269                                         <li><span class="type">MODULE</span> <a href="MCollective/Connector.html">MCollective::Connector</a></li>
270                                         
271                                         <li><span class="type">MODULE</span> <a href="MCollective/DDL.html">MCollective::DDL</a></li>
272                                         
273                                         <li><span class="type">MODULE</span> <a href="MCollective/Data.html">MCollective::Data</a></li>
274                                         
275                                         <li><span class="type">MODULE</span> <a href="MCollective/Facts.html">MCollective::Facts</a></li>
276                                         
277                                         <li><span class="type">MODULE</span> <a href="MCollective/Generators.html">MCollective::Generators</a></li>
278                                         
279                                         <li><span class="type">MODULE</span> <a href="MCollective/Logger.html">MCollective::Logger</a></li>
280                                         
281                                         <li><span class="type">MODULE</span> <a href="MCollective/Matcher.html">MCollective::Matcher</a></li>
282                                         
283                                         <li><span class="type">MODULE</span> <a href="MCollective/PluginManager.html">MCollective::PluginManager</a></li>
284                                         
285                                         <li><span class="type">MODULE</span> <a href="MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
286                                         
287                                         <li><span class="type">MODULE</span> <a href="MCollective/RPC.html">MCollective::RPC</a></li>
288                                         
289                                         <li><span class="type">MODULE</span> <a href="MCollective/Registration.html">MCollective::Registration</a></li>
290                                         
291                                         <li><span class="type">MODULE</span> <a href="MCollective/Security.html">MCollective::Security</a></li>
292                                         
293                                         <li><span class="type">MODULE</span> <a href="MCollective/Translatable.html">MCollective::Translatable</a></li>
294                                         
295                                         <li><span class="type">MODULE</span> <a href="MCollective/Util.html">MCollective::Util</a></li>
296                                         
297                                         <li><span class="type">MODULE</span> <a href="MCollective/Validator.html">MCollective::Validator</a></li>
298                                         
299                                         <li><span class="type">CLASS</span> <a href="MCollective/Agents.html">MCollective::Agents</a></li>
300                                         
301                                         <li><span class="type">CLASS</span> <a href="MCollective/Aggregate.html">MCollective::Aggregate</a></li>
302                                         
303                                         <li><span class="type">CLASS</span> <a href="MCollective/Application.html">MCollective::Application</a></li>
304                                         
305                                         <li><span class="type">CLASS</span> <a href="MCollective/Applications.html">MCollective::Applications</a></li>
306                                         
307                                         <li><span class="type">CLASS</span> <a href="MCollective/Client.html">MCollective::Client</a></li>
308                                         
309                                         <li><span class="type">CLASS</span> <a href="MCollective/CodedError.html">MCollective::CodedError</a></li>
310                                         
311                                         <li><span class="type">CLASS</span> <a href="MCollective/Config.html">MCollective::Config</a></li>
312                                         
313                                         <li><span class="type">CLASS</span> <a href="MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
314                                         
315                                         <li><span class="type">CLASS</span> <a href="MCollective/Discovery.html">MCollective::Discovery</a></li>
316                                         
317                                         <li><span class="type">CLASS</span> <a href="MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
318                                         
319                                         <li><span class="type">CLASS</span> <a href="MCollective/Log.html">MCollective::Log</a></li>
320                                         
321                                         <li><span class="type">CLASS</span> <a href="MCollective/Message.html">MCollective::Message</a></li>
322                                         
323                                         <li><span class="type">CLASS</span> <a href="MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
324                                         
325                                         <li><span class="type">CLASS</span> <a href="MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
326                                         
327                                         <li><span class="type">CLASS</span> <a href="MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
328                                         
329                                         <li><span class="type">CLASS</span> <a href="MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
330                                         
331                                         <li><span class="type">CLASS</span> <a href="MCollective/Optionparser.html">MCollective::Optionparser</a></li>
332                                         
333                                         <li><span class="type">CLASS</span> <a href="MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
334                                         
335                                         <li><span class="type">CLASS</span> <a href="MCollective/RPCError.html">MCollective::RPCError</a></li>
336                                         
337                                         <li><span class="type">CLASS</span> <a href="MCollective/Runner.html">MCollective::Runner</a></li>
338                                         
339                                         <li><span class="type">CLASS</span> <a href="MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
340                                         
341                                         <li><span class="type">CLASS</span> <a href="MCollective/SSL.html">MCollective::SSL</a></li>
342                                         
343                                         <li><span class="type">CLASS</span> <a href="MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
344                                         
345                                         <li><span class="type">CLASS</span> <a href="MCollective/Shell.html">MCollective::Shell</a></li>
346                                         
347                                         <li><span class="type">CLASS</span> <a href="MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
348                                         
349                                         <li><span class="type">CLASS</span> <a href="MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
350                                         
351                                         <li><span class="type">CLASS</span> <a href="MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
352                                         
353                                         <li><span class="type">CLASS</span> <a href="MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
354                                         
355                                         <li><span class="type">CLASS</span> <a href="MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
356                                         
357                                 </ul>
358                         </div>
359                         
360
361                         <!-- Method Quickref -->
362                         
363                         <div id="method-list-section" class="section">
364                                 <h3 class="section-header">Methods</h3>
365                                 <ul class="link-list">
366                                         
367                                         <li><a href="#M000000">::version</a></li>
368                                         
369                                 </ul>
370                         </div>
371                         
372
373                         <!-- Included Modules -->
374                         
375                 </div>
376
377                 <div id="project-metadata">
378                         
379                         
380                         <div id="fileindex-section" class="section project-section">
381                                 <h3 class="section-header">Files</h3>
382                                 <ul>
383                                 
384                                         <li class="file"><a href="./COPYING.html">COPYING</a></li>
385                                 
386                                         <li class="file"><a href="./Gemfile.html">Gemfile</a></li>
387                                 
388                                         <li class="file"><a href="./README.html">README</a></li>
389                                 
390                                         <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
391                                 
392                                         <li class="file"><a href="./etc/client_cfg_dist.html">client.cfg.dist</a></li>
393                                 
394                                         <li class="file"><a href="./etc/data-help_erb.html">data-help.erb</a></li>
395                                 
396                                         <li class="file"><a href="./etc/discovery-help_erb.html">discovery-help.erb</a></li>
397                                 
398                                         <li class="file"><a href="./etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
399                                 
400                                         <li class="file"><a href="./etc/metadata-help_erb.html">metadata-help.erb</a></li>
401                                 
402                                         <li class="file"><a href="./etc/msg-help_erb.html">msg-help.erb</a></li>
403                                 
404                                         <li class="file"><a href="./etc/rpc-help_erb.html">rpc-help.erb</a></li>
405                                 
406                                         <li class="file"><a href="./etc/server_cfg_dist.html">server.cfg.dist</a></li>
407                                 
408                                         <li class="file"><a href="./etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
409                                 
410                                         <li class="file"><a href="./etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
411                                 
412                                         <li class="file"><a href="./lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
413                                 
414                                         <li class="file"><a href="./lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
415                                 
416                                         <li class="file"><a href="./lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
417                                 
418                                         <li class="file"><a href="./lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
419                                 
420                                         <li class="file"><a href="./lib/mcollective/locales/en_yml.html">en.yml</a></li>
421                                 
422                                         <li class="file"><a href="./mcollective_init.html">mcollective.init</a></li>
423                                 
424                                 </ul>
425                         </div>
426                         
427
428                         <div id="classindex-section" class="section project-section">
429                                 <h3 class="section-header">Class Index
430                                         <span class="search-toggle"><img src="./images/find.png"
431                                                 height="16" width="16" alt="[+]"
432                                                 title="show/hide quicksearch" /></span></h3>
433                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
434                                 <fieldset>
435                                         <legend>Quicksearch</legend>
436                                         <input type="text" name="quicksearch" value=""
437                                                 class="quicksearch-field" />
438                                 </fieldset>
439                                 </form>
440
441                                 <ul class="link-list">
442                                 
443                                         <li><a href="./MCollective.html">MCollective</a></li>
444                                 
445                                         <li><a href="./MCollective/Agent.html">MCollective::Agent</a></li>
446                                 
447                                         <li><a href="./MCollective/Agents.html">MCollective::Agents</a></li>
448                                 
449                                         <li><a href="./MCollective/Aggregate.html">MCollective::Aggregate</a></li>
450                                 
451                                         <li><a href="./MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
452                                 
453                                         <li><a href="./MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
454                                 
455                                         <li><a href="./MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
456                                 
457                                         <li><a href="./MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
458                                 
459                                         <li><a href="./MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
460                                 
461                                         <li><a href="./MCollective/Application.html">MCollective::Application</a></li>
462                                 
463                                         <li><a href="./MCollective/Applications.html">MCollective::Applications</a></li>
464                                 
465                                         <li><a href="./MCollective/Cache.html">MCollective::Cache</a></li>
466                                 
467                                         <li><a href="./MCollective/Client.html">MCollective::Client</a></li>
468                                 
469                                         <li><a href="./MCollective/CodedError.html">MCollective::CodedError</a></li>
470                                 
471                                         <li><a href="./MCollective/Config.html">MCollective::Config</a></li>
472                                 
473                                         <li><a href="./MCollective/Connector.html">MCollective::Connector</a></li>
474                                 
475                                         <li><a href="./MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
476                                 
477                                         <li><a href="./MCollective/DDL.html">MCollective::DDL</a></li>
478                                 
479                                         <li><a href="./MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
480                                 
481                                         <li><a href="./MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
482                                 
483                                         <li><a href="./MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
484                                 
485                                         <li><a href="./MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
486                                 
487                                         <li><a href="./MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
488                                 
489                                         <li><a href="./MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
490                                 
491                                         <li><a href="./MCollective/Data.html">MCollective::Data</a></li>
492                                 
493                                         <li><a href="./MCollective/Data/Base.html">MCollective::Data::Base</a></li>
494                                 
495                                         <li><a href="./MCollective/Data/Result.html">MCollective::Data::Result</a></li>
496                                 
497                                         <li><a href="./MCollective/Discovery.html">MCollective::Discovery</a></li>
498                                 
499                                         <li><a href="./MCollective/Facts.html">MCollective::Facts</a></li>
500                                 
501                                         <li><a href="./MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
502                                 
503                                         <li><a href="./MCollective/Generators.html">MCollective::Generators</a></li>
504                                 
505                                         <li><a href="./MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
506                                 
507                                         <li><a href="./MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
508                                 
509                                         <li><a href="./MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
510                                 
511                                         <li><a href="./MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
512                                 
513                                         <li><a href="./MCollective/Log.html">MCollective::Log</a></li>
514                                 
515                                         <li><a href="./MCollective/Logger.html">MCollective::Logger</a></li>
516                                 
517                                         <li><a href="./MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
518                                 
519                                         <li><a href="./MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
520                                 
521                                         <li><a href="./MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
522                                 
523                                         <li><a href="./MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
524                                 
525                                         <li><a href="./MCollective/Matcher.html">MCollective::Matcher</a></li>
526                                 
527                                         <li><a href="./MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
528                                 
529                                         <li><a href="./MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
530                                 
531                                         <li><a href="./MCollective/Message.html">MCollective::Message</a></li>
532                                 
533                                         <li><a href="./MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
534                                 
535                                         <li><a href="./MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
536                                 
537                                         <li><a href="./MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
538                                 
539                                         <li><a href="./MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
540                                 
541                                         <li><a href="./MCollective/Optionparser.html">MCollective::Optionparser</a></li>
542                                 
543                                         <li><a href="./MCollective/PluginManager.html">MCollective::PluginManager</a></li>
544                                 
545                                         <li><a href="./MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
546                                 
547                                         <li><a href="./MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
548                                 
549                                         <li><a href="./MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
550                                 
551                                         <li><a href="./MCollective/RPC.html">MCollective::RPC</a></li>
552                                 
553                                         <li><a href="./MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
554                                 
555                                         <li><a href="./MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
556                                 
557                                         <li><a href="./MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
558                                 
559                                         <li><a href="./MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
560                                 
561                                         <li><a href="./MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
562                                 
563                                         <li><a href="./MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
564                                 
565                                         <li><a href="./MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
566                                 
567                                         <li><a href="./MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
568                                 
569                                         <li><a href="./MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
570                                 
571                                         <li><a href="./MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
572                                 
573                                         <li><a href="./MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
574                                 
575                                         <li><a href="./MCollective/RPCError.html">MCollective::RPCError</a></li>
576                                 
577                                         <li><a href="./MCollective/Registration.html">MCollective::Registration</a></li>
578                                 
579                                         <li><a href="./MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
580                                 
581                                         <li><a href="./MCollective/Runner.html">MCollective::Runner</a></li>
582                                 
583                                         <li><a href="./MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
584                                 
585                                         <li><a href="./MCollective/SSL.html">MCollective::SSL</a></li>
586                                 
587                                         <li><a href="./MCollective/Security.html">MCollective::Security</a></li>
588                                 
589                                         <li><a href="./MCollective/Security/Base.html">MCollective::Security::Base</a></li>
590                                 
591                                         <li><a href="./MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
592                                 
593                                         <li><a href="./MCollective/Shell.html">MCollective::Shell</a></li>
594                                 
595                                         <li><a href="./MCollective/Translatable.html">MCollective::Translatable</a></li>
596                                 
597                                         <li><a href="./MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
598                                 
599                                         <li><a href="./MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
600                                 
601                                         <li><a href="./MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
602                                 
603                                         <li><a href="./MCollective/Util.html">MCollective::Util</a></li>
604                                 
605                                         <li><a href="./MCollective/Validator.html">MCollective::Validator</a></li>
606                                 
607                                         <li><a href="./MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
608                                 
609                                         <li><a href="./MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
610                                 
611                                         <li><a href="./Array.html">Array</a></li>
612                                 
613                                         <li><a href="./Dir.html">Dir</a></li>
614                                 
615                                         <li><a href="./Object.html">Object</a></li>
616                                 
617                                         <li><a href="./String.html">String</a></li>
618                                 
619                                         <li><a href="./Symbol.html">Symbol</a></li>
620                                 
621                                 </ul>
622                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
623                         </div>
624
625                         
626                 </div>
627         </div>
628
629         <div id="documentation">
630                 <h1 class="module">MCollective</h1>
631
632                 <div id="description">
633                         <h2>The Marionette Collective</h2>
634 <p>
635 Framework to build and run Systems Administration agents running on a
636 publish/subscribe middleware system. The system allows you to treat your
637 network as the only true source of the state of your platform via discovery
638 agents and allow you to run agents matching discovery criteria.
639 </p>
640 <p>
641 For an overview of the idea behind this and what it enables please see:
642 </p>
643 <pre>
644   http://www.devco.net/archives/2009/10/18/middleware_for_systems_administration.php
645 </pre>
646
647                 </div>
648
649                 <!-- Constants -->
650                 
651                 <div id="constants-list" class="section">
652                         <h3 class="section-header">Constants</h3>
653                         <dl>
654                         
655                                 <dt><a name="VERSION">VERSION</a></dt>
656                                 
657                                 <dd class="description missing-docs">(Not documented)</dd>
658                                 
659                         
660                         </dl>
661                 </div>
662                 
663
664                 <!-- Attributes -->
665                 
666
667                 <!-- Methods -->
668                 
669                 <div id="public-class-method-details" class="method-section section">
670                         <h3 class="section-header">Public Class Methods</h3>
671
672                 
673                         <div id="version-method" class="method-detail ">
674                                 <a name="M000000"></a>
675
676                                 <div class="method-heading">
677                                 
678                                         <span class="method-name">version</span><span
679                                                 class="method-args">()</span>
680                                         <span class="method-click-advice">click to toggle source</span>
681                                 
682                                 </div>
683
684                                 <div class="method-description">
685                                         
686                                         <p class="missing-docs">(Not documented)</p>
687                                         
688
689                                         
690                                         <div class="method-source-code"
691                                                 id="version-source">
692 <pre>
693     <span class="ruby-comment cmt"># File lib/mcollective.rb, line 65</span>
694 65:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">version</span>
695 66:     <span class="ruby-constant">VERSION</span>
696 67:   <span class="ruby-keyword kw">end</span></pre>
697                                         </div>
698                                         
699                                 </div>
700
701                                 
702                         </div>
703
704                 
705                 </div>
706         
707
708         </div>
709
710
711         <div id="rdoc-debugging-section-dump" class="debugging-section">
712         
713                 <p>Disabled; run with --debug to generate this.</p>
714         
715         </div>
716
717         <div id="validator-badges">
718                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
719                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
720                         Rdoc Generator</a> 1.1.6</small>.</p>
721         </div>
722
723 </body>
724 </html>
725