doc/rdocs/Rcmd.html in rcmd-1.6.5 vs doc/rdocs/Rcmd.html in rcmd-1.6.6
- old
+ new
@@ -50,11 +50,20 @@
</div>
</div>
+<div class="nav-section">
+ <h3>Table of Contents</h3>
+ <ul class="link-list" role="directory">
+ <li><a href="#module-Rcmd-label-begin+rdoc">begin rdoc</a>
+ <li><a href="#module-Rcmd-label-end">end</a>
+ </ul>
+</div>
+
+
<div id="class-metadata">
@@ -77,20 +86,22 @@
module Rcmd
</h1>
<section class="description">
+<h1 id="module-Rcmd-label-begin+rdoc">begin rdoc<span><a href="#module-Rcmd-label-begin+rdoc">¶</a> <a href="#top">↑</a></span></h1>
+
<p>This module is for parellel remote (SSH) execution of a single command
string on Multiple hosts. The module itself consists of one method for
execution (Rcmd.run_command) which does not accept any arguments. The
required arguments are set as variables through the use of accessors.</p>
+<h1 id="module-Rcmd-label-end">end<span><a href="#module-Rcmd-label-end">¶</a> <a href="#top">↑</a></span></h1>
+
</section>
-
-
<section id="5Buntitled-5D" class="documentation-section">
@@ -154,10 +165,36 @@
<p>An array of hosts to run the given command on. (Manditory)</p>
</div>
</div>
+ <div id="attribute-c-hosts_file" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">hosts_file</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>String fo path to user_known_hosts_file</p>
+
+ </div>
+ </div>
+
+ <div id="attribute-c-keys_only" class="method-detail">
+ <div class="method-heading attribute-method-heading">
+ <span class="method-name">keys_only</span><span
+ class="attribute-access-type">[RW]</span>
+ </div>
+
+ <div class="method-description">
+
+ <p>Boolean for using only ssh-keys or not</p>
+
+ </div>
+ </div>
+
<div id="attribute-c-nthreads" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">nthreads</span><span
class="attribute-access-type">[RW]</span>
</div>
@@ -275,12 +312,12 @@
<div class="method-source-code" id="run_command-source">
- <pre><span class="ruby-comment"># File lib/rcmd.rb, line 80</span>
-<span class="ruby-keyword">def</span> <span class="ruby-constant">Rcmd</span>.<span class="ruby-identifier">run_command</span>()
+ <pre><span class="ruby-comment"># File lib/rcmd.rb, line 86</span>
+<span class="ruby-keyword">def</span> <span class="ruby-constant">Rcmd</span>.<span class="ruby-identifier ruby-title">run_command</span>()
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@command</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"No command set for execution"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@host_list</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">>=</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"host_list must contain at least one system"</span>)
@@ -294,13 +331,13 @@
<span class="ruby-comment"># Prepare threads</span>
<span class="ruby-ivar">@threads</span> = [ ]
<span class="ruby-identifier">num_threads</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@threads</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> {
<span class="ruby-keyword">begin</span>
- <span class="ruby-identifier">conn_options</span> = { <span class="ruby-value">:user</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@user</span>, <span class="ruby-value">:host</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@queue</span>.<span class="ruby-identifier">pop</span>, <span class="ruby-value">:password</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:quiet</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@quiet</span>, <span class="ruby-value">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@debug</span> }
+ <span class="ruby-identifier">conn_options</span> = { <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@user</span>, <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@queue</span>.<span class="ruby-identifier">pop</span>, <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:quiet</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@quiet</span>, <span class="ruby-value">:debug</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@debug</span>, <span class="ruby-value">:keys_only</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@keys_only</span>, <span class="ruby-value">:user_known_hosts_file</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@hosts_file</span>}
<span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">print</span> <span class="ruby-node">"DEBUG :: Connecting to #{conn_options[:host]}\n"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:debug</span>]
- <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span>.<span class="ruby-identifier">start</span>(<span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:host</span>], <span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:user</span>], <span class="ruby-value">:password</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:passwd</span>]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">session</span><span class="ruby-operator">|</span>
+ <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span>.<span class="ruby-identifier">start</span>(<span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:host</span>], <span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:user</span>], <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:passwd</span>]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">session</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># Open channel for input/output control</span>
<span class="ruby-identifier">session</span>.<span class="ruby-identifier">open_channel</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">channel</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-comment"># Print recieved data if quiet is not true</span>
<span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">print</span> <span class="ruby-node">"#{conn_options[:host]} :: #{data}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">conn_options</span>[<span class="ruby-value">:quiet</span>]
@@ -342,10 +379,10 @@
</section>
</main>
<footer id="validator-badges" role="contentinfo">
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.0.
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.0.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>