-
-
+
-
-
-
-
-
- + +
+ +
+
+
+
+
+
+
+
+
+
+ In Files
+
+
+ -
+
+
- lib/mcollective/optionparser.rb + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parent
+ + + +
+
+
+
+
+
+ Methods
+-
+
+
- ::new + +
- #add_common_options + +
- #add_filter_options + +
- #add_required_options + +
- #parse + +
- #parse_fact + +
+
+
+
+
+
+
+
+ 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::Optionparser
+ +
+
-
-
- A simple helper to build cli tools that supports a uniform command line layout.
-
-
-
- Methods
- - -
-
-
-
-
-
-
+
-
-
-
-
-
-
- Attributes
- -
-
-
-
- | parser | -[R] | -- |
-
+
+ Public Class methods
- -
-
-
-
-
-
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+ -Creates a new instance of the -parser, you can supply defaults and include named groups of options. +
+
+
+ Public Class Methods
+ + +
+
+
+
+
+
+
+
+ new(defaults = {}, include_sections = nil, exclude_sections = nil)
+ click to toggle source
+
+
+
+
+
+
-
- +Creates a new instance of the parser, you can supply defaults and include +named groups of options.
Starts a parser that defaults to verbose and that includs the filter @@ -165,9 +411,11 @@ Starts a parser in verbose mode that does not show the common options:
oparser = MCollective::Optionparser.new({:verbose => true}, "filter", "common")
-
-
+
+
+
+
-
-
# File lib/mcollective/optionparser.rb, line 20
20: def initialize(defaults = {}, include_sections = nil, exclude_sections = nil)
@@ -179,30 +427,42 @@ Starts a parser in verbose mode that does not show the common options:
26: @options = Util.default_options
27:
28: @options.merge!(defaults)
-29: end
-
- Public Instance methods
- - + + +
+
+
+
+ Public Instance Methods
+ + +
+
+
+
+
+
+
+
+ add_common_options()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ These options will be added to most cli tools
- -
+
+
+
+
-
-
# File lib/mcollective/optionparser.rb, line 128
128: def add_common_options
@@ -257,29 +517,37 @@ These options will be added to most cli tools
177: @parser.on("--threaded", "Start publishing requests and receiving responses in threaded mode.") do |v|
178: @options[:threaded] = true
179: end
-180: end
-
-
+
+
+
+
+
+
+
+ add_filter_options()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ These options will be added if you pass ‘filter’ into the include list of the constructor.
- -
+
+
+
+
-
-
# File lib/mcollective/optionparser.rb, line 73
73: def add_filter_options
@@ -318,28 +586,36 @@ include list of the constructor.
106: @parser.on('-I', '--wi', '--with-identity IDENT', 'Match hosts with a certain configured identity') do |a|
107: @options[:filter]["identity"] << a
108: end
-109: end
-
-
+
+
+
+
+
+
+
+ add_required_options()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ These options should always be present
- -
+
+
+
+
-
-
# File lib/mcollective/optionparser.rb, line 112
112: def add_required_options
@@ -355,23 +631,29 @@ These options should always be present
122: puts @parser
123: exit! 1
124: end
-125: end
-
-
+
+
+
+
+
+
+ parse(&block)
+ click to toggle source
+
+
+
+
+
+
+69: end
+ Parse the options returning the options, you can pass a block that adds additional options to the Optionparser.
@@ -394,9 +676,11 @@ message specific to this app. Users can set default options that get parsed in using the MCOLLECTIVE_EXTRA_OPTS environemnt variable - -
+
+
+
+
-
-
# File lib/mcollective/optionparser.rb, line 48
48: def parse(&block)
@@ -420,22 +704,73 @@ MCOLLECTIVE_EXTRA_OPTS environemnt variable
66: @options[:collective] = Config.instance.main_collective unless @options[:collective]
67:
68: @options
-69: end
-
-
+
+
+