nexpose-functions 0.0.4 → 0.0.5

data/doc/Nexpose/Connection.html

@@ -135,6 +135,56 @@
 <p>Get an Asset object for the specified host IP.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#getScanTemplatesbyId-instance_method" title="#getScanTemplatesbyId (instance method)">- (Hash) <strong>getScanTemplatesbyId</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Get a Hash object containing pairs of scan template names/ids where the
+Hash key is the scan template id.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#getScanTemplatesbyName-instance_method" title="#getScanTemplatesbyName (instance method)">- (Hash) <strong>getScanTemplatesbyName</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Get a Hash object containing pairs of scan template names/ids where the
+Hash key is the scan template name.</p>
+</div></span>
+  
 </li>
 
       
@@ -358,15 +408,153 @@ days.</p>
       <pre class="lines">
 
 
+111
+112
+113</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 111</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_getAsset'>getAsset</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='rparen'>)</span>
+    <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='const'>Nexpose</span><span class='op'>::</span><span class='const'>Search</span><span class='op'>::</span><span class='const'>Field</span><span class='op'>::</span><span class='const'>ASSET</span><span class='comma'>,</span> <span class='const'>Nexpose</span><span class='op'>::</span><span class='const'>Search</span><span class='op'>::</span><span class='const'>Operator</span><span class='op'>::</span><span class='const'>IS</span><span class='comma'>,</span> <span class='id identifier rubyid_host'>host</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="getScanTemplatesbyId-instance_method">
+  
+    - (<tt>Hash</tt>) <strong>getScanTemplatesbyId</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Get a Hash object containing pairs of scan template names/ids where the
+Hash key is the scan template id.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>object with scan template ids as the keys and scan template names as the
+values.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
 88
 89
-90</pre>
+90
+91
+92
+93
+94</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 88</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_getAsset'>getAsset</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='rparen'>)</span>
-    <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='const'>Nexpose</span><span class='op'>::</span><span class='const'>Search</span><span class='op'>::</span><span class='const'>Field</span><span class='op'>::</span><span class='const'>ASSET</span><span class='comma'>,</span> <span class='const'>Nexpose</span><span class='op'>::</span><span class='const'>Search</span><span class='op'>::</span><span class='const'>Operator</span><span class='op'>::</span><span class='const'>IS</span><span class='comma'>,</span> <span class='id identifier rubyid_host'>host</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_getScanTemplatesbyId'>getScanTemplatesbyId</span><span class='lparen'>(</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_templateinfo'>templateinfo</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_scan_templates'>list_scan_templates</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_template'>template</span><span class='op'>|</span>
+        <span class='id identifier rubyid_templateinfo'>templateinfo</span><span class='lbracket'>[</span><span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
+    <span class='rbrace'>}</span>
+    <span class='kw'>return</span> <span class='id identifier rubyid_templateinfo'>templateinfo</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="getScanTemplatesbyName-instance_method">
+  
+    - (<tt>Hash</tt>) <strong>getScanTemplatesbyName</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Get a Hash object containing pairs of scan template names/ids where the
+Hash key is the scan template name.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>object with scan template names as the keys and scan template ids as the
+values.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+99
+100
+101
+102
+103
+104
+105</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 99</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_getScanTemplatesbyName'>getScanTemplatesbyName</span><span class='lparen'>(</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_templateinfo'>templateinfo</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+    <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_scan_templates'>list_scan_templates</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_template'>template</span><span class='op'>|</span>
+        <span class='id identifier rubyid_templateinfo'>templateinfo</span><span class='lbracket'>[</span><span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
+    <span class='rbrace'>}</span>
+    <span class='kw'>return</span> <span class='id identifier rubyid_templateinfo'>templateinfo</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -491,7 +679,8 @@ the site name.</p>
 79
 80
 81
-82</pre>
+82
+83</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 77</span>
@@ -499,8 +688,9 @@ the site name.</p>
 <span class='kw'>def</span> <span class='id identifier rubyid_getSitesInfobyName'>getSitesInfobyName</span><span class='lparen'>(</span><span class='rparen'>)</span>
     <span class='id identifier rubyid_sitesinfo'>sitesinfo</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
     <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_list_sites'>list_sites</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_site'>site</span><span class='op'>|</span>
-        <span class='id identifier rubyid_sitesinfo'>sitesinfo</span><span class='lbracket'>[</span><span class='id identifier rubyid_site'>site</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sites'>sites</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
+        <span class='id identifier rubyid_sitesinfo'>sitesinfo</span><span class='lbracket'>[</span><span class='id identifier rubyid_site'>site</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_site'>site</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
     <span class='rbrace'>}</span>
+    <span class='kw'>return</span> <span class='id identifier rubyid_sitesinfo'>sitesinfo</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -572,12 +762,12 @@ days.</p>
       <pre class="lines">
 
 
-96
-97
-98</pre>
+119
+120
+121</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 96</span>
+      <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 119</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_notScannedSince'>notScannedSince</span><span class='lparen'>(</span><span class='id identifier rubyid_days'>days</span><span class='rparen'>)</span>
     <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='const'>Nexpose</span><span class='op'>::</span><span class='const'>Search</span><span class='op'>::</span><span class='const'>Field</span><span class='op'>::</span><span class='const'>SCAN_DATE</span><span class='comma'>,</span> <span class='const'>Nexpose</span><span class='op'>::</span><span class='const'>Search</span><span class='op'>::</span><span class='const'>Operator</span><span class='op'>::</span><span class='const'>EARLIER_THAN</span><span class='comma'>,</span> <span class='id identifier rubyid_days'>days</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='rparen'>)</span>
@@ -857,7 +1047,7 @@ days.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Nov 18 10:25:54 2014 by
+  Generated on Fri Dec  5 14:41:35 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/Nexpose/Site.html

@@ -209,25 +209,25 @@
       <pre class="lines">
 
 
-107
-108
-109
-110
-111
-112
-113
-114
-115
-116
-117
-118
-119
-120
-121
-122</pre>
+130
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
+144
+145</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 107</span>
+      <pre class="code"><span class="info file"># File 'lib\nexpose-functions.rb', line 130</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_load_csv_hostnames'>load_csv_hostnames</span><span class='lparen'>(</span><span class='id identifier rubyid_nsc'>nsc</span><span class='comma'>,</span> <span class='id identifier rubyid_csvfile'>csvfile</span><span class='rparen'>)</span>
     <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Loading site...</span><span class='tstring_end'>&quot;</span></span>
@@ -255,7 +255,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Nov 18 10:25:54 2014 by
+  Generated on Fri Dec  5 14:41:35 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -111,7 +111,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Nov 18 10:25:53 2014 by
+  Generated on Fri Dec  5 14:41:35 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -111,7 +111,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Nov 18 10:25:53 2014 by
+  Generated on Fri Dec  5 14:41:35 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/doc/method_list.html

@@ -63,6 +63,18 @@
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="Nexpose/Connection.html#getScanTemplatesbyId-instance_method" title="Nexpose::Connection#getScanTemplatesbyId (method)">#getScanTemplatesbyId</a></span>
+    <small>Nexpose::Connection</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Nexpose/Connection.html#getScanTemplatesbyName-instance_method" title="Nexpose::Connection#getScanTemplatesbyName (method)">#getScanTemplatesbyName</a></span>
+    <small>Nexpose::Connection</small>
+  </li>
+  
+
   <li class="r1 ">
     <span class='object_link'><a href="Nexpose/Connection.html#getSitesInfobyId-instance_method" title="Nexpose::Connection#getSitesInfobyId (method)">#getSitesInfobyId</a></span>
     <small>Nexpose::Connection</small>

data/doc/top-level-namespace.html

@@ -235,7 +235,7 @@
 </div>
 
     <div id="footer">
-  Generated on Tue Nov 18 10:25:53 2014 by
+  Generated on Fri Dec  5 14:41:35 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-1.9.3).
 </div>

data/lib/nexpose-functions.rb

@@ -79,6 +79,29 @@ class Nexpose::Connection
         self.list_sites.each { |site|
             sitesinfo[site.name] = site.id
         }
+        return sitesinfo
+    end
+    
+    # Get a Hash object containing pairs of scan template names/ids where the Hash key is the scan template id.
+    #
+    # @return [Hash] object with scan template ids as the keys and scan template names as the values.
+    def getScanTemplatesbyId()
+        templateinfo = {}
+        self.list_scan_templates.each { |template|
+            templateinfo[template.id] = template.name
+        }
+        return templateinfo
+    end
+    
+    # Get a Hash object containing pairs of scan template names/ids where the Hash key is the scan template name.
+    #
+    # @return [Hash] object with scan template names as the keys and scan template ids as the values.
+    def getScanTemplatesbyName()
+        templateinfo = {}
+        self.list_scan_templates.each { |template|
+            templateinfo[template.name] = template.id
+        }
+        return templateinfo
     end
 
     # Get an Asset object for the specified host IP.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose-functions
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Additional useful functions for use with the Nexpose API.
 email: