-
-
-
-
-
-
-
-
- + +
+ +
+
+
+
+
+
+
+
+
+
+ In Files
+
+
+ -
+
+
- lib/mcollective/rpc/helpers.rb + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parent
+ + + +
+
+
+
+
+
+ Methods
+-
+
+
- ::add_simplerpc_options + +
- ::extract_hosts_from_array + +
- ::extract_hosts_from_json + +
- ::old_rpcresults + +
- ::rpcresults + +
- ::text_for_flattened_result + +
- ::text_for_result + +
+
+
+
+
+
+
+
+ Files
+-
+
+
- COPYING + +
- Gemfile + +
- README + +
- Rakefile + +
- client.cfg.dist + +
- data-help.erb + +
- discovery-help.erb + +
- facts.yaml.dist + +
- metadata-help.erb + +
- msg-help.erb + +
- rpc-help.erb + +
- server.cfg.dist + +
- PLACEHOLDER + +
- PLACEHOLDER + +
- action_snippet.erb + +
- data_input_snippet.erb + +
- ddl.erb + +
- plugin.erb + +
- en.yml + +
- mcollective.init + +
+ Class Index
+
+
+
+
+
+
+ Class Index
+ ![[+]](../../images/find.png "show/hide quicksearch")
+
+
+ -
+
+
- MCollective + +
- MCollective::Agent + +
- MCollective::Agents + +
- MCollective::Aggregate + +
- MCollective::Aggregate::Base + +
- MCollective::Aggregate::Result + +
- MCollective::Aggregate::Result::Base + +
- MCollective::Aggregate::Result::CollectionResult + +
- MCollective::Aggregate::Result::NumericResult + +
- MCollective::Application + +
- MCollective::Applications + +
- MCollective::Cache + +
- MCollective::Client + +
- MCollective::CodedError + +
- MCollective::Config + +
- MCollective::Connector + +
- MCollective::Connector::Base + +
- MCollective::DDL + +
- MCollective::DDL::AgentDDL + +
- MCollective::DDL::Base + +
- MCollective::DDL::DataDDL + +
- MCollective::DDL::DiscoveryDDL + +
- MCollective::DDL::ValidatorDDL + +
- MCollective::DDLValidationError + +
- MCollective::Data + +
- MCollective::Data::Base + +
- MCollective::Data::Result + +
- MCollective::Discovery + +
- MCollective::Facts + +
- MCollective::Facts::Base + +
- MCollective::Generators + +
- MCollective::Generators::AgentGenerator + +
- MCollective::Generators::Base + +
- MCollective::Generators::DataGenerator + +
- MCollective::InvalidRPCData + +
- MCollective::Log + +
- MCollective::Logger + +
- MCollective::Logger::Base + +
- MCollective::Logger::Console_logger + +
- MCollective::Logger::File_logger + +
- MCollective::Logger::Syslog_logger + +
- MCollective::Matcher + +
- MCollective::Matcher::Parser + +
- MCollective::Matcher::Scanner + +
- MCollective::Message + +
- MCollective::MissingRPCData + +
- MCollective::MsgDoesNotMatchRequestID + +
- MCollective::MsgTTLExpired + +
- MCollective::NotTargettedAtUs + +
- MCollective::Optionparser + +
- MCollective::PluginManager + +
- MCollective::PluginPackager + +
- MCollective::PluginPackager::AgentDefinition + +
- MCollective::PluginPackager::StandardDefinition + +
- MCollective::RPC + +
- MCollective::RPC::ActionRunner + +
- MCollective::RPC::Agent + +
- MCollective::RPC::Audit + +
- MCollective::RPC::Client + +
- MCollective::RPC::Helpers + +
- MCollective::RPC::Progress + +
- MCollective::RPC::Reply + +
- MCollective::RPC::Request + +
- MCollective::RPC::Result + +
- MCollective::RPC::Stats + +
- MCollective::RPCAborted + +
- MCollective::RPCError + +
- MCollective::Registration + +
- MCollective::Registration::Base + +
- MCollective::Runner + +
- MCollective::RunnerStats + +
- MCollective::SSL + +
- MCollective::Security + +
- MCollective::Security::Base + +
- MCollective::SecurityValidationFailed + +
- MCollective::Shell + +
- MCollective::Translatable + +
- MCollective::UnixDaemon + +
- MCollective::UnknownRPCAction + +
- MCollective::UnknownRPCError + +
- MCollective::Util + +
- MCollective::Validator + +
- MCollective::ValidatorError + +
- MCollective::WindowsDaemon + +
- Array + +
- Dir + +
- Object + +
- String + +
- Symbol + +
+
-
- MCollective::RPC::Helpers
+ +
+
-
-
- Various utilities for the RPC system
-
-
-
- Methods
- - -
-
+
+
+
+
+
+
+
+
+
+
+ Public Class Methods
- + +
+
+
+
+
+
+ add_simplerpc_options(parser, options)
+ click to toggle source
+
+
-
-
-
- Public Class methods
- -
-
-
-
-
-
+
+
-
+
+
+ +
+
+
-
-
+
+
+ Add SimpleRPC common options
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 254
254: def self.add_simplerpc_options(parser, options)
@@ -187,29 +427,37 @@ Add SimpleRPC common options
300:
301: raise "--display has to be one of 'ok', 'all' or 'failed'" unless [:ok, :failed, :always].include?(options[:force_display_mode])
302: end
-303: end
-
-
+
+
+
+
+
+
+
+ extract_hosts_from_array(hosts)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Given an array of something, make sure each is a string chomp off any new lines and return just the array of hosts
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 29
29: def self.extract_hosts_from_array(hosts)
@@ -217,25 +465,31 @@ lines and return just the array of hosts
31: raise "#{host} should be a string" unless host.is_a?(String)
32: host.chomp
33: end
-34: end
-
-
+
+
+
+
+
+
+
+ extract_hosts_from_json(json)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Parse JSON output as produced by printrpc and extract the -"sender" of each rpc response +“sender” of each rpc response
The simplist valid JSON based data would be: @@ -250,9 +504,11 @@ The simplist valid JSON based data would be:
]
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 14
14: def self.extract_hosts_from_json(json)
@@ -266,29 +522,37 @@ The simplist valid JSON based data would be:
22:
23: host["sender"]
24: end.uniq
-25: end
-
-
+
+
+
+
+
+
+
+ old_rpcresults(result, flags = {})
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Backward compatible display block for results without a DDL
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 202
202: def self.old_rpcresults(result, flags = {})
@@ -340,23 +604,29 @@ href="../DDL.html">DDL
248: end
249:
250: result_text << ""
-251: end
-
-
+
+
+
+
+
+
+
+ rpcresults(result, flags = {})
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Returns a blob of text representing the results in a standard way
@@ -378,13 +648,15 @@ flags: printrpc exim.mailq, :verbose => true
-If you‘ve asked it to flatten the result it will not print sender -hostnames, it will just print the result as if it‘s one huge result, +If you’ve asked it to flatten the result it will not print sender +hostnames, it will just print the result as if it’s one huge result, handy for things like showing a combined mailq.
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 54
54: def self.rpcresults(result, flags = {})
@@ -449,28 +721,36 @@ handy for things like showing a combined mailq.
113: end
114:
115: result_text
-116: end
-
-
+
+
+
+
+
+
+
+ text_for_flattened_result(status, result)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Returns text representing a flattened result of only good data
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 189
189: def self.text_for_flattened_result(status, result)
@@ -483,28 +763,36 @@ Returns text representing a flattened result of only good data
196: result_text << result
197: end
198: end
-199: end
-
-
+
+
+
+
+
+
+ text_for_result(sender, status, msg, result, ddl)
+ click to toggle source
+
+
+
+
+
+
+186: end
+ Return text representing a result
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/helpers.rb, line 119
119: def self.text_for_result(sender, status, msg, result, ddl)
@@ -574,22 +862,33 @@ Return text representing a result
183:
184: result_text << "\n"
185: result_text
-186: end
-
-