doc/lib/mcollective/locales/en_yml.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
   5 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   6 <head>
   7         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   8
   9         <title>File: en.yml [mcollective version 2.3.3]</title>
  10
  11         <link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet" />
  12
  13         <script src="../../../js/jquery.js" type="text/javascript"
  14                 charset="utf-8"></script>
  15         <script src="../../../js/thickbox-compressed.js" type="text/javascript"
  16                 charset="utf-8"></script>
  17         <script src="../../../js/quicksearch.js" type="text/javascript"
  18                 charset="utf-8"></script>
  19         <script src="../../../js/darkfish.js" type="text/javascript"
  20                 charset="utf-8"></script>
  21 </head>
  22
  23 <body class="file">
  24         <div id="metadata">
  25                 <div id="project-metadata">
  26
  27
  28                         <div id="fileindex-section" class="section project-section">
  29                                 <h3 class="section-header">Files</h3>
  30                                 <ul>
  31
  32                                         <li class="file"><a href="../../../COPYING.html">COPYING</a></li>
  33
  34                                         <li class="file"><a href="../../../Gemfile.html">Gemfile</a></li>
  35
  36                                         <li class="file"><a href="../../../README.html">README</a></li>
  37
  38                                         <li class="file"><a href="../../../Rakefile.html">Rakefile</a></li>
  39
  40                                         <li class="file"><a href="../../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  41
  42                                         <li class="file"><a href="../../../etc/data-help_erb.html">data-help.erb</a></li>
  43
  44                                         <li class="file"><a href="../../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  45
  46                                         <li class="file"><a href="../../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  47
  48                                         <li class="file"><a href="../../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
  49
  50                                         <li class="file"><a href="../../../etc/msg-help_erb.html">msg-help.erb</a></li>
  51
  52                                         <li class="file"><a href="../../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
  53
  54                                         <li class="file"><a href="../../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
  55
  56                                         <li class="file"><a href="../../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
  57
  58                                         <li class="file"><a href="../../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
  59
  60                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
  61
  62                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
  63
  64                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
  65
  66                                         <li class="file"><a href="../../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
  67
  68                                         <li class="file"><a href="../../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
  69
  70                                         <li class="file"><a href="../../../mcollective_init.html">mcollective.init</a></li>
  71
  72                                 </ul>
  73                         </div>
  74
  75
  76                         <div id="classindex-section" class="section project-section">
  77                                 <h3 class="section-header">Class Index
  78                                         <span class="search-toggle"><img src="../../../images/find.png"
  79                                                 height="16" width="16" alt="[+]"
  80                                                 title="show/hide quicksearch" /></span></h3>
  81                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
  82                                 <fieldset>
  83                                         <legend>Quicksearch</legend>
  84                                         <input type="text" name="quicksearch" value=""
  85                                                 class="quicksearch-field" />
  86                                 </fieldset>
  87                                 </form>
  88
  89                                 <ul class="link-list">
  90
  91                                         <li><a href="../../../MCollective.html">MCollective</a></li>
  92
  93                                         <li><a href="../../../MCollective/Agent.html">MCollective::Agent</a></li>
  94
  95                                         <li><a href="../../../MCollective/Agents.html">MCollective::Agents</a></li>
  96
  97                                         <li><a href="../../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
  98
  99                                         <li><a href="../../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 100
 101                                         <li><a href="../../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 102
 103                                         <li><a href="../../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 104
 105                                         <li><a href="../../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 106
 107                                         <li><a href="../../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 108
 109                                         <li><a href="../../../MCollective/Application.html">MCollective::Application</a></li>
 110
 111                                         <li><a href="../../../MCollective/Applications.html">MCollective::Applications</a></li>
 112
 113                                         <li><a href="../../../MCollective/Cache.html">MCollective::Cache</a></li>
 114
 115                                         <li><a href="../../../MCollective/Client.html">MCollective::Client</a></li>
 116
 117                                         <li><a href="../../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 118
 119                                         <li><a href="../../../MCollective/Config.html">MCollective::Config</a></li>
 120
 121                                         <li><a href="../../../MCollective/Connector.html">MCollective::Connector</a></li>
 122
 123                                         <li><a href="../../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 124
 125                                         <li><a href="../../../MCollective/DDL.html">MCollective::DDL</a></li>
 126
 127                                         <li><a href="../../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 128
 129                                         <li><a href="../../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 130
 131                                         <li><a href="../../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 132
 133                                         <li><a href="../../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 134
 135                                         <li><a href="../../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 136
 137                                         <li><a href="../../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 138
 139                                         <li><a href="../../../MCollective/Data.html">MCollective::Data</a></li>
 140
 141                                         <li><a href="../../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 142
 143                                         <li><a href="../../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 144
 145                                         <li><a href="../../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 146
 147                                         <li><a href="../../../MCollective/Facts.html">MCollective::Facts</a></li>
 148
 149                                         <li><a href="../../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 150
 151                                         <li><a href="../../../MCollective/Generators.html">MCollective::Generators</a></li>
 152
 153                                         <li><a href="../../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 154
 155                                         <li><a href="../../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 156
 157                                         <li><a href="../../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 158
 159                                         <li><a href="../../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 160
 161                                         <li><a href="../../../MCollective/Log.html">MCollective::Log</a></li>
 162
 163                                         <li><a href="../../../MCollective/Logger.html">MCollective::Logger</a></li>
 164
 165                                         <li><a href="../../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 166
 167                                         <li><a href="../../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 168
 169                                         <li><a href="../../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 170
 171                                         <li><a href="../../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 172
 173                                         <li><a href="../../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 174
 175                                         <li><a href="../../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 176
 177                                         <li><a href="../../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 178
 179                                         <li><a href="../../../MCollective/Message.html">MCollective::Message</a></li>
 180
 181                                         <li><a href="../../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 182
 183                                         <li><a href="../../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 184
 185                                         <li><a href="../../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 186
 187                                         <li><a href="../../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 188
 189                                         <li><a href="../../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 190
 191                                         <li><a href="../../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 192
 193                                         <li><a href="../../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 194
 195                                         <li><a href="../../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 196
 197                                         <li><a href="../../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 198
 199                                         <li><a href="../../../MCollective/RPC.html">MCollective::RPC</a></li>
 200
 201                                         <li><a href="../../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 202
 203                                         <li><a href="../../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 204
 205                                         <li><a href="../../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 206
 207                                         <li><a href="../../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 208
 209                                         <li><a href="../../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 210
 211                                         <li><a href="../../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 212
 213                                         <li><a href="../../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 214
 215                                         <li><a href="../../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 216
 217                                         <li><a href="../../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 218
 219                                         <li><a href="../../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 220
 221                                         <li><a href="../../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 222
 223                                         <li><a href="../../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 224
 225                                         <li><a href="../../../MCollective/Registration.html">MCollective::Registration</a></li>
 226
 227                                         <li><a href="../../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 228
 229                                         <li><a href="../../../MCollective/Runner.html">MCollective::Runner</a></li>
 230
 231                                         <li><a href="../../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 232
 233                                         <li><a href="../../../MCollective/SSL.html">MCollective::SSL</a></li>
 234
 235                                         <li><a href="../../../MCollective/Security.html">MCollective::Security</a></li>
 236
 237                                         <li><a href="../../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 238
 239                                         <li><a href="../../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 240
 241                                         <li><a href="../../../MCollective/Shell.html">MCollective::Shell</a></li>
 242
 243                                         <li><a href="../../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 244
 245                                         <li><a href="../../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 246
 247                                         <li><a href="../../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 248
 249                                         <li><a href="../../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 250
 251                                         <li><a href="../../../MCollective/Util.html">MCollective::Util</a></li>
 252
 253                                         <li><a href="../../../MCollective/Validator.html">MCollective::Validator</a></li>
 254
 255                                         <li><a href="../../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 256
 257                                         <li><a href="../../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 258
 259                                         <li><a href="../../../Array.html">Array</a></li>
 260
 261                                         <li><a href="../../../Dir.html">Dir</a></li>
 262
 263                                         <li><a href="../../../Object.html">Object</a></li>
 264
 265                                         <li><a href="../../../String.html">String</a></li>
 266
 267                                         <li><a href="../../../Symbol.html">Symbol</a></li>
 268
 269                                 </ul>
 270                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 271                         </div>
 272
 273
 274                 </div>
 275         </div>
 276
 277         <div id="documentation">
 278                 <p>
 279 en:
 280 </p>
 281 <pre>
 282   PLMC1:
 283     example: &quot;The Marionette Collective version 2.2.2 started by /usr/bin/mco using config file /etc/mcollective/client.cfg&quot;
 284     expanded: &quot;This message gets logged each time MCollective reads it's config file.  Generally this only happens once per process.  It shows the version, process name and config file as a simple debugging aid&quot;
 285     pattern: &quot;The Marionette Collective version %{version} started by %{name} using config file %{config}&quot;
 286   PLMC10:
 287     example: &quot;Failed to handle message: RuntimeError: none.rb:15:in `decodemsg': Could not decrypt message &quot;
 288     expanded: |-
 289         When a message arrives from the middleware it gets decoded, security validated and then dispatched to the agent code.
 290
 291         There exist a number of errors that can happen here, some are handled specifically others will be logged by this &quot;catch all&quot; handler.
 292
 293         Generally there should not be many messages logged here but we include a stack trace to assist with debugging these.
 294
 295         The messages here do not tend to originate from your Agents unless they are syntax error related but more likely to be situations like security failures due to incorrect SSL keys and so forth
 296
 297         Should you come across one that is a regular accorance in your logs please open a ticket including your backtrace and we will improve the handling of that situation
 298     pattern: &quot;Failed to handle message: %{error}&quot;
 299   PLMC11:
 300     example: &quot;Cache expired on 'ddl' key 'agent/nrpe'&quot;
 301     expanded: |-
 302         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
 303
 304         Each entry in the cache has an associated TTL or maximum life time, once the maximum time on an item is reached it is considered expired.  Next time anything attempts to read this entry from the cache this log line will be logged.
 305
 306         This is part of the normal operations of MCollective and doesn't indicate any problem.  We log this debug message to help you debug your own use of the cache.
 307     pattern: &quot;Cache expired on '%{cache_name}' key '%{item}'&quot;
 308   PLMC12:
 309     example: &quot;Cache hit on 'ddl' key 'agent/nrpe'&quot;
 310     expanded: |-
 311         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
 312
 313         Each entry in the cache has an associated TTL or maximum life time, once the maximum time on an item is reached it is considered expired.
 314
 315         This log line indicates that a request for a cache entry was made, the entry had not yet expired and so the cached data is being returned.
 316
 317         It does not indicate a problem, it's just a debugging aid
 318     pattern: &quot;Cache hit on '%{cache_name}' key '%{item}'&quot;
 319   PLMC13:
 320     example: &quot;Could not find a cache called 'my_cache'&quot;
 321     expanded: |-
 322         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
 323
 324         The cache is made up of many named caches, this error indicates that a cache has not yet been setup prior to trying to use it.
 325     pattern: &quot;Could not find a cache called '%{cache_name}'&quot;
 326   PLMC14:
 327     example: &quot;No block supplied to synchronize on cache 'my_cache'&quot;
 328     expanded: |-
 329         When using the Cache to synchronize your own code across agents or other plugins you have to supply a block to synchronise.
 330
 331         Correct usage would be:
 332
 333             Cache.setup(:customer, 600)
 334             Cache(:customer).synchronize do
 335                # update customer record
 336             end
 337
 338         This error is raise when the logic to update the customer record is not in a block as in the example
 339     pattern: &quot;No block supplied to synchronize on cache '%{cache_name}'&quot;
 340   PLMC15:
 341     example: &quot;No item called 'nrpe_agent' for cache 'ddl'&quot;
 342     expanded: |-
 343         MCollective has an internal Cache used to speed up operations like parsing of DDL files.  The cache is also usable from the agents and other plugins you write.
 344
 345         The cache stored items using a key, this error will be logged and raised when you try to access a item that does not yet exist in the cache.
 346     pattern: &quot;No item called '%{item}' for cache '%{cache_name}'&quot;
 347   PLMC16:
 348     example: &quot;'hello' does not look like a numeric value&quot;
 349     expanded: |-
 350         When MCollective receives an argument from the command line like port=fello it consults the DDL file to determine the desired type of this parameter, it then tries to convert the input string into the correct numeric value.
 351
 352         This error indicates the input you provided could not be converted into the desired format.
 353
 354         You'll usually see this when using the 'mco rpc' command to interact with an agent.  This is usually a fatal error, the request will not be sent if it does not validate against the DDL.
 355     pattern: &quot;'%{value}' does not look like a numeric value&quot;
 356   PLMC17:
 357     example: &quot;'flase' does not look like a boolean value&quot;
 358     expanded: |-
 359         When MCollective receives an argument from the command line like force=true it consults the DDL file to determine the desired type of this parameter, it then tries to convert the input string into the correct boolean value.
 360
 361         This error indicates the input you provided could not be converted into the desired boolean format.  It wil accept &quot;true&quot;, &quot;t&quot;, &quot;yes&quot;, &quot;y&quot; and &quot;1&quot; as being true.  It will accept &quot;false&quot;, &quot;f&quot;, &quot;no&quot;, &quot;n&quot;, &quot;0&quot; as being false.
 362
 363         You'll usually see this when using the 'mco rpc' command to interact with an agent.  This is usually a fatal error, the request will not be sent if it does not validate against the DDL.
 364     pattern: &quot;'%{value}' does not look like a boolean value&quot;
 365   PLMC18:
 366     example: &quot;Found 'rpcutil' ddl at '/usr/libexec/mcollective/mcollective/agent/rpcutil.ddl'&quot;
 367     expanded: |-
 368         Most plugin types have a DDL file that needs to be correctly installed for the plugin to function.  There can be multiple libdirs that can provide the DDL file for a specific plugin.
 369
 370         This message is a message designed to help you debug issues when you think the wrong DDL file is being used.
 371     pattern: &quot;Found '%{ddlname}' ddl at '%{ddlfile}'&quot;
 372   PLMC19:
 373     expanded: |-
 374         Usually when MCollective run it validates all requirements are met before publishing a request or processing a request against the DDL file for the agent.
 375
 376         This can be difficult to satisfy in development perhaps because you are still writing your DDL files or debugging issues.
 377
 378         This message indicates that when MCollective detects it's running against an unreleased version of MCollective - like directly out of a Git clone - it will skip the DDL validation steps.  It is logged at a warning level as this significantly changes the behaviour of the client and server.
 379     pattern: &quot;DDL requirements validation being skipped in development&quot;
 380   PLMC2:
 381     expanded: &quot;When sending the mcollectived process the USR1 signal on a Unix based machine this message will indicate that the signal got received and all agents are being reloaded from disk\n&quot;
 382     pattern: &quot;Reloading all agents after receiving USR1 signal&quot;
 383   PLMC20:
 384     example: &quot;Agent plugin 'example' requires MCollective version 2.2.1 or newer&quot;
 385     expanded: |-
 386         MCollective plugins can declare a minimum version of MCollective that they require to be functional.
 387
 388         MCollective validates this when it loads the plugin and this error will be logged or shown to the user when this requirement cannot be satisfied.
 389     pattern: &quot;%{type} plugin '%{name}' requires MCollective version %{requirement} or newer&quot;
 390   PLMC21:
 391     example: &quot;Cannot validate input 'service': Input string is longer than 40 character(s)&quot;
 392     expanded: |-
 393         Every input you provide to a RPC request is validated against it's DDL file. This error will be shown when the supplied data does not pass validation against the DDL.
 394
 395         Consult the 'mco plugin doc' command to view the DDL file for your action and input.
 396     pattern: &quot;Cannot validate input '%{input}: %{error}&quot;
 397   PLMC22:
 398     example: &quot;Cannot determine what entity input 'port' belongs to&quot;
 399     expanded: |-
 400         When writing a DDL you declare inputs into plugins using the input keyword.  Each input has to belong to a wrapping entity like in the example below:
 401
 402             action &quot;get_data&quot;, :description =&gt; &quot;Get data from a data plugin&quot; do
 403                 input :source,
 404                       :prompt      =&gt; &quot;Data Source&quot;,
 405                       :description =&gt; &quot;The data plugin to retrieve information from&quot;,
 406                       :type        =&gt; :string,
 407                       :validation  =&gt; '^\w+$',
 408                       :optional    =&gt; false,
 409                       :maxlength   =&gt; 50
 410             end
 411
 412         Here the input belongs to the action entity &quot;get_data&quot;, this error indicates that an input were found without it belonging to any specific entity
 413     pattern: &quot;Cannot determine what entity input '%{input}' belongs to&quot;
 414   PLMC23:
 415     example: &quot;Input needs a :prompt property&quot;
 416     expanded: &quot;When writing a DDL you declare inputs for all data that you pass into the plugin.  Inputs have a minimally required field set and this error indicate that you did not provide some key field while describing the input.&quot;
 417     pattern: &quot;Input needs a :%{property} property&quot;
 418   PLMC24:
 419     example: &quot;Failed to load DDL for the 'rpcutil' agent, DDLs are required: RuntimeError: failed to parse DDL file&quot;
 420     expanded: |-
 421         As of version 2.0.0 DDL files are required by the MCollective server.  This server indicates that it either could not find the DDL for the rpcutil agent or that there was a syntax error.
 422
 423         Confirm that the DDL file is installed in the agent directory and that it parses correctly using the 'mco plugin doc' command.
 424     pattern: &quot;Failed to load DDL for the '%{agent}' agent, DDLs are required: %{error_class}: %{error}&quot;
 425   PLMC25:
 426     example: &quot;aggregate method for action 'rpcutil' is missing a function parameter&quot;
 427     expanded: |-
 428         DDL files can declare aggregation rules for the data returned by actions as seen below:
 429
 430                  summarize do
 431                     aggregate summary(:collectives)
 432                  end
 433
 434         This error indicates that you did not supply the argument - :collectives in this example.
 435     pattern: &quot;aggregate method for action '%{action}' is missing a function parameter&quot;
 436   PLMC26:
 437     expanded: |-
 438         Internally when MCollective parse the DDL it converts the aggregate functions into a hash with the function name and any arguments.
 439
 440         This error indicates that the internal translation failed, this is a critical error and would probably indicate a structure problem in your DDL or a bug in MCollective
 441     pattern: &quot;Functions supplied to aggregate should be a hash&quot;
 442   PLMC27:
 443     expanded: |-
 444         DDL aggregate functions can take a custom format as in the example below:
 445
 446             aggregate average(:total_resources, :format =&gt; &quot;Average: %d&quot;)
 447
 448         This error indicate that the :format above could not be correctly parsed.
 449     pattern: &quot;Formats supplied to aggregation functions must have a :format key&quot;
 450   PLMC28:
 451     expanded: |-
 452         DDL aggregate functions can take a custom format as in the example below:
 453
 454             aggregate average(:total_resources, :format =&gt; &quot;Average: %d&quot;)
 455
 456         This error indicate that the :format above was not supplied as a hash as in the above example
 457     pattern: &quot;Formats supplied to aggregation functions should be a hash&quot;
 458   PLMC29:
 459     example: &quot;Attempted to call action 'yum_clean' for 'package' but it's not declared in the DDL&quot;
 460     expanded: |-
 461         Every agent has a DDL file that describes valid actions that they can perform
 462
 463         This error indicates you attempted to perform an action that does not exist.  Review the plugin documentation using 'mco plugin doc' for correct usage
 464     pattern: &quot;Attempted to call action '%{action}' for '%{plugin}' but it's not declared in the DDL&quot;
 465   PLMC3:
 466     expanded: |-
 467         When sending the mcollectived process the USR2 signal on a Unix based machine this message indicates that the signal for received and the logging level is being adjusted to the next higher level or back down to debug if it was already at it's highest level.
 468
 469         This message will be followed by another message similar to the one below:
 470
 471             Logging level is now WARN
 472     pattern: &quot;Cycling logging level due to USR2 signal&quot;
 473   PLMC30:
 474     example: &quot;Action 'get_fact' needs a 'fact' argument&quot;
 475     expanded: &quot;Actions can declare that they expect a required input, this error indicates that you did not supply the required input&quot;
 476     pattern: &quot;Action '%{action}' needs a '%{key}' argument&quot;
 477   PLMC31:
 478     example: &quot;No dataquery has been defined in the DDL for data plugin 'package'&quot;
 479     expanded: |-
 480         Each data plugin requires a DDL that has a 'dataquery' block in it.
 481
 482             dataquery :description =&gt; &quot;Agent Meta Data&quot; do
 483                 .
 484                 .
 485             end
 486
 487         This error indicates that the DDL file for a specific data plugin did not contain this block.
 488     pattern: &quot;No dataquery has been defined in the DDL for data plugin '%{plugin}'&quot;
 489   PLMC32:
 490     expanded: &quot;Data plugins must return data.  The DDL files for a data plugin must declare at least one output parameter else you will see this error.&quot;
 491     pattern: &quot;No output has been defined in the DDL for data plugin '%{plugin}'&quot;
 492   PLMC33:
 493     example: &quot;No data plugin argument was declared in the 'puppet' DDL but an input was supplied&quot;
 494     expanded: |-
 495         Data plugins can take an optional input argument.  This error indicate that you supplied an input argument but the plugin does not actually expect any input.
 496
 497         Review the documentation for the data plugin using 'mco plugin doc'
 498     pattern: &quot;No data plugin argument was declared in the '%{plugin}' DDL but an input was supplied&quot;
 499   PLMC34:
 500     example: &quot;setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the 'package' agent&quot;
 501     expanded: |-
 502         In the past each MCollective agent had a metadata section containing information like the timeout.
 503
 504         As of 2.2.0 the agents will now consult the DDL files that ship with each agent for this purpose so the metadata in agents are not used at all.
 505
 506         In order to remove confusing duplication setting metadata in agents have been deprecated and from version 2.4.0 will not be supported at all.
 507
 508         Please update your agent by removing the metadata section from it and make sure the DDL file has the correct information instead.
 509     pattern: &quot;setting meta data in agents have been deprecated, DDL files are now being used for this information. Please update the '%{agent}' agent&quot;
 510   PLMC35:
 511     expanded: |-
 512         The MCollective client can ask that the agent just performs the action and never respond.  Like when supplying the --no-results option to the 'mco rpc' application.
 513
 514         This log line indicates that the request was received and interpreted as such and no reply will be sent.  This does not indicate a problem generally it's just there to assist with debugging of problems.
 515     pattern: &quot;Client did not request a response, surpressing reply&quot;
 516   PLMC36:
 517     example: &quot;Unknown action 'png' for agent 'rpcutil'&quot;
 518     expanded: |-
 519         Agents are made up of a number of named actions.  When the MCollective Server receives a request it double checks if the agent in question actually implements the logic for a specific action.
 520
 521         When it cannot find the implementation this error will be raised.  This is an unusual situation since at this point on both the client and the server the DDL will already have been used to validate the request and the DDL would have indicated that the action is valid.
 522
 523         Check your agent code and make sure you have code like:
 524
 525             action &quot;the_action&quot; do
 526                 .
 527                 .
 528             end
 529     pattern: &quot;Unknown action '%{action}' for agent '%{agent}'&quot;
 530   PLMC37:
 531     example: &quot;Starting default activation checks for the 'rpcutil' agent&quot;
 532     expanded: |-
 533         Each time the MCollective daemon starts it loads each agent from disk.  It then tries to determine if the agent should start on this node by using the activate_when method or per-agent configuration.
 534
 535         This is a debug statement that shows you it is about to start interacting with the logic in the agent to determine if it should be made available or not.
 536     pattern: &quot;Starting default activation checks for the '%{agent}' agent&quot;
 537   PLMC38:
 538     example: &quot;Found plugin configuration 'exim.activate_agent' with value 'y'&quot;
 539     expanded: |-
 540         The administrator can choose that a certain agent that is deployed on this machine should not be made available to the network.
 541
 542         To do this you would add a configuration value like this example to the mcollective server.cfg:
 543
 544             plugin.exim.activate_agent = n
 545
 546         If this value is &quot;1&quot;, &quot;y&quot; or &quot;true&quot; the agent will be activated else it will be disabled.
 547     pattern: &quot;Found plugin configuration '%{agent}.activate_agent' with value '%{should_activate}'&quot;
 548   PLMC39:
 549     example: &quot;Audit failed with an error, processing the request will continue.&quot;
 550     expanded: |-
 551         Every MCollective request can be audited.  In the event where the auditing fails the processing continues.
 552
 553         At present the failure handling is not configurable, in future the administrator might elect to not run unaudited requests via configuration.
 554   PLMC4:
 555     example: &quot;Failed to start registration plugin: ArgumentError: meta.rb:6:in `gsub': wrong number of arguments (0 for 2)&quot;
 556     expanded: |
 557         Registration plugins are loaded into the MCollective daemon at startup and ran on a regular interval.
 558
 559         This message indicate that on first start this plugin failed to run, it will show the exception class, line and exception message to assist with debugging
 560     pattern: &quot;Failed to start registration plugin: %{error}&quot;
 561   PLMC40:
 562     example: &quot;Can't find DDL for agent plugin 'puppet'&quot;
 563     expanded: |-
 564         MCollective plugins come with DDL files that describe their behaviours, versions, capabilities and requirements.
 565
 566         This error indicate that a DDL file for the plugin mentioned could not be found - it could be that you have a typing error in your command line or an installation error.
 567     pattern: &quot;Can't find DDL for %{type} plugin '%{name}'&quot;
 568   PLMC41:
 569     example: &quot;Data plugin 'agent()' function does not return a 'foo' value&quot;
 570     expanded: |-
 571         Data functions return a set of values which can be identified by name.
 572
 573         This message indicates that the specified value has not been defined in the Data plugin's DDL.
 574     pattern: &quot;Data plugin '%{functionname}()' does not return a '%{value}' value&quot;
 575   PLMC42:
 576     example: &quot;Cannot convert string value 'hello' into a boolean. &quot;
 577     expanded: |-
 578         This error gets logged when there is an attempt to convert a string value into a boolean, but the string does not match the boolean pattern.
 579
 580         Strings that match &quot;1&quot;, &quot;y&quot;, &quot;yes&quot;, &quot;YES&quot;, &quot;t&quot;, &quot;true&quot; and &quot;TRUE&quot; will be transformed into a boolean true.
 581
 582         Strings that match &quot;0&quot;, &quot;n&quot;, &quot;no&quot;, &quot;NO&quot;, &quot;f&quot;, &quot;false&quot; and &quot;FALSE&quot; will be transformed into a boolean false.
 583     pattern: &quot;Cannot convert string value '%{value}' into a boolean. &quot;
 584   PLMC5:
 585     expanded: |-
 586         In previous versions of MCollective a application called 'controller' were included that had the ability to request agent reloads and other commands that would control the runner.
 587
 588         Unfortunately this method of controlling the daemon was never considered stable or reliable and has since been deprecate for removal during the 2.3.x development series
 589     pattern: &quot;Received a control message, possibly via 'mco controller' but this has been deprecated&quot;
 590   PLMC6:
 591     expanded: |-
 592         When a specific MCollective daemon receives a message from a network it validates the filter before processing the message.  The filter is the list of classes, facts or other conditions that are associated with any message.
 593
 594         In the case where the filter does not match the specific host this line gets logged.
 595
 596         It's often the case for broadcast messages that all MCollective nodes will receive a message but only a subset of nodes are targetted using the filters, in that situation the nodes that received the request but should not respond to it will see this log line.
 597
 598         It does not indicate anything to be concerned about but if you find debugging a problem and expect a node to have responded when it shouldn't this log line will give you a hint that some condition specified in the filter did not match the local host
 599     pattern: &quot;Message does not pass filters, ignoring&quot;
 600   PLMC7:
 601     example: &quot;Exiting after signal: SignalException: runner.rb:6:in `run': Interrupt&quot;
 602     expanded: |-
 603         When the MCollective daemon gets a signal from the Operating System that it does not specifically handle it will log this line before exiting.
 604
 605         You would see this whenever the daemon is stopped by init script or when sending it a kill signal, it will then proceed to disconnect from the middleware and exit its main loop
 606     pattern: &quot;Exiting after signal: %{error}&quot;
 607   PLMC8:
 608     example: &quot;Handling message for agent 'rpcutil' on collective 'eu_collective' with requestid 'a8a78d0ff555c931f045b6f448129846'&quot;
 609     expanded: |-
 610         After receiving a message from the middleware, decoding it, validating it's security credentials and doing other checks on it the MCollective daemon will pass it off to the actual agent code for processing.
 611
 612         Prior to doing so it will log this line indicating the agent name and sub-collective and other information that will assist in correlating the message sent from the client with those in the server logs being processed.
 613     pattern: &quot;Handling message for agent '%{agent}' on collective '%{collective} with requestid '%{requestid}'&quot;
 614   PLMC9:
 615     example: &quot;Expired Message: message 8b4fe522f0d0541dabe83ec10b7fa446 from cert=client@node created at 1358840888 is 653 seconds old, TTL is 60&quot;
 616     expanded: |-
 617         Requests sent from clients to servers all have a creation time and a maximum validity time called a TTL.
 618
 619         This message indicates that a message was received from the network but that it was determined to be too based on the TTL settings.
 620
 621         Usually this happens because your clocks are not in sync - something that can be fixed by rolling out a tool like ntp across your server estate.
 622
 623         It might also happen during very slow network conditions or when the TTL is set too low for your general network latency.
 624     pattern: &quot;Expired Message: %{error}&quot;
 625 </pre>
 626
 627         </div>
 628
 629         <div id="validator-badges">
 630                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 631                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 632                         Rdoc Generator</a> 1.1.6</small>.</p>
 633         </div>
 634 </body>
 635 </html>
 636