vipruby 0.1.7 → 0.1.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +14 -4
  3. data/.yardoc/object_types +0 -0
  4. data/.yardoc/objects/root.dat +0 -0
  5. data/{LICENSE.txt → LICENSE} +2 -2
  6. data/README.md +94 -12
  7. data/doc/Vipr.html +139 -29
  8. data/doc/ViprAutoTier.html +426 -0
  9. data/doc/ViprBase.html +1 -1
  10. data/doc/ViprBlockVirtualPool.html +859 -0
  11. data/doc/ViprFileVirtualPool.html +859 -0
  12. data/doc/ViprHost.html +1 -1
  13. data/doc/ViprServiceCatalog.html +800 -0
  14. data/doc/ViprStoragePool.html +664 -0
  15. data/doc/ViprStoragePort.html +664 -0
  16. data/doc/ViprStorageSystem.html +2588 -805
  17. data/doc/ViprStorageTier.html +323 -0
  18. data/doc/ViprTenant.html +529 -0
  19. data/doc/ViprVcenter.html +1 -1
  20. data/doc/ViprVirtualArray.html +1230 -0
  21. data/doc/ViprVirtualDataCenter.html +407 -0
  22. data/doc/Vipruby.html +2 -2
  23. data/doc/_index.html +51 -1
  24. data/doc/class_list.html +1 -1
  25. data/doc/file.README.html +71 -26
  26. data/doc/index.html +71 -26
  27. data/doc/method_list.html +438 -12
  28. data/doc/top-level-namespace.html +2 -2
  29. data/lib/doc/_index.html +88 -0
  30. data/lib/doc/class_list.html +58 -0
  31. data/lib/doc/css/common.css +1 -0
  32. data/lib/doc/css/full_list.css +57 -0
  33. data/lib/doc/css/style.css +339 -0
  34. data/lib/doc/file_list.html +57 -0
  35. data/lib/doc/frames.html +26 -0
  36. data/lib/doc/index.html +88 -0
  37. data/lib/doc/js/app.js +219 -0
  38. data/lib/doc/js/full_list.js +181 -0
  39. data/lib/doc/js/jquery.js +4 -0
  40. data/lib/doc/method_list.html +57 -0
  41. data/lib/doc/top-level-namespace.html +102 -0
  42. data/lib/vipruby.rb +1 -5
  43. data/lib/vipruby/objects/autotier.rb +30 -0
  44. data/lib/vipruby/objects/blockvirtualpool.rb +74 -0
  45. data/lib/vipruby/objects/filevirtualpool.rb +74 -0
  46. data/lib/vipruby/objects/servicecatalog.rb +81 -0
  47. data/lib/vipruby/objects/storagepool.rb +80 -0
  48. data/lib/vipruby/objects/storageport.rb +62 -0
  49. data/lib/vipruby/objects/storagesystem.rb +169 -0
  50. data/lib/vipruby/objects/storagetier.rb +21 -0
  51. data/lib/vipruby/objects/tenant.rb +39 -0
  52. data/lib/vipruby/objects/virtualarray.rb +100 -0
  53. data/lib/vipruby/objects/virtualdatacenter.rb +28 -0
  54. data/lib/vipruby/version.rb +1 -1
  55. data/lib/vipruby/vipr.rb +25 -5
  56. data/vipruby.gemspec +2 -2
  57. metadata +39 -6
@@ -0,0 +1,407 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: ViprVirtualDataCenter
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!ViprVirtualDataCenter.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (V)</a> &raquo;
35
+
36
+
37
+ <span class="title">ViprVirtualDataCenter</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: ViprVirtualDataCenter
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <dt class="r1">Included in:</dt>
81
+ <dd class="r1"><span class='object_link'><a href="Vipr.html" title="Vipr (class)">Vipr</a></span></dd>
82
+
83
+
84
+
85
+ <dt class="r2 last">Defined in:</dt>
86
+ <dd class="r2 last">lib/vipruby/objects/virtualdatacenter.rb</dd>
87
+
88
+ </dl>
89
+ <div class="clear"></div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>The following VirtualDataCenter calls will get and execute
95
+ VirtualDataCenter items</p>
96
+
97
+
98
+ </div>
99
+ </div>
100
+ <div class="tags">
101
+
102
+
103
+ </div>
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+ <h2>
112
+ Instance Method Summary
113
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
114
+ </h2>
115
+
116
+ <ul class="summary">
117
+
118
+ <li class="public ">
119
+ <span class="summary_signature">
120
+
121
+ <a href="#get_vdc-instance_method" title="#get_vdc (instance method)">- (JSON) <strong>get_vdc</strong>(vdc_id, auth = nil, cert = nil) </a>
122
+
123
+
124
+
125
+ </span>
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <span class="summary_desc"><div class='inline'>
136
+ <p>Get single VirtualDataCenter information.</p>
137
+ </div></span>
138
+
139
+ </li>
140
+
141
+
142
+ <li class="public ">
143
+ <span class="summary_signature">
144
+
145
+ <a href="#get_vdc_secretkey-instance_method" title="#get_vdc_secretkey (instance method)">- (JSON) <strong>get_vdc_secretkey</strong>(auth = nil, cert = nil) </a>
146
+
147
+
148
+
149
+ </span>
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'>
160
+ <p>Get single VirtualDataCenter Secret-Key.</p>
161
+ </div></span>
162
+
163
+ </li>
164
+
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#get_vdcs-instance_method" title="#get_vdcs (instance method)">- (json) <strong>get_vdcs</strong>(auth = nil, cert = nil) </a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <span class="summary_desc"><div class='inline'>
184
+ <p>Get All VirtualDataCenters.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ </ul>
191
+
192
+
193
+
194
+
195
+ <div id="instance_method_details" class="method_details_list">
196
+ <h2>Instance Method Details</h2>
197
+
198
+
199
+ <div class="method_details first">
200
+ <h3 class="signature first" id="get_vdc-instance_method">
201
+
202
+ - (<tt>JSON</tt>) <strong>get_vdc</strong>(vdc_id, auth = nil, cert = nil)
203
+
204
+
205
+
206
+
207
+
208
+ </h3><div class="docstring">
209
+ <div class="discussion">
210
+
211
+ <p>Get single VirtualDataCenter information</p>
212
+
213
+
214
+ </div>
215
+ </div>
216
+ <div class="tags">
217
+ <p class="tag_title">Parameters:</p>
218
+ <ul class="param">
219
+
220
+ <li>
221
+
222
+ <span class='name'>vdc_id</span>
223
+
224
+
225
+ <span class='type'>(<tt>urn:id</tt>)</span>
226
+
227
+
228
+
229
+ &mdash;
230
+ <div class='inline'>
231
+ <p>URN of a VirtualDatacenter. Required Param</p>
232
+ </div>
233
+
234
+ </li>
235
+
236
+ </ul>
237
+
238
+ <p class="tag_title">Returns:</p>
239
+ <ul class="return">
240
+
241
+ <li>
242
+
243
+
244
+ <span class='type'>(<tt>JSON</tt>)</span>
245
+
246
+
247
+
248
+ &mdash;
249
+ <div class='inline'>
250
+ <p>The JSON object of the VirtualDataCenter</p>
251
+ </div>
252
+
253
+ </li>
254
+
255
+ </ul>
256
+
257
+ </div><table class="source_code">
258
+ <tr>
259
+ <td>
260
+ <pre class="lines">
261
+
262
+
263
+ 17
264
+ 18
265
+ 19</pre>
266
+ </td>
267
+ <td>
268
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/virtualdatacenter.rb', line 17</span>
269
+
270
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vdc'>get_vdc</span><span class='lparen'>(</span><span class='id identifier rubyid_vdc_id'>vdc_id</span><span class='comma'>,</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
271
+ <span class='id identifier rubyid_rest_get'>rest_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vdc/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vdc_id'>vdc_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='ivar'>@auth_token</span> <span class='op'>:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='ivar'>@verify_cert</span> <span class='op'>:</span> <span class='id identifier rubyid_cert'>cert</span><span class='rparen'>)</span>
272
+ <span class='kw'>end</span></pre>
273
+ </td>
274
+ </tr>
275
+ </table>
276
+ </div>
277
+
278
+ <div class="method_details ">
279
+ <h3 class="signature " id="get_vdc_secretkey-instance_method">
280
+
281
+ - (<tt>JSON</tt>) <strong>get_vdc_secretkey</strong>(auth = nil, cert = nil)
282
+
283
+
284
+
285
+
286
+
287
+ </h3><div class="docstring">
288
+ <div class="discussion">
289
+
290
+ <p>Get single VirtualDataCenter Secret-Key</p>
291
+
292
+
293
+ </div>
294
+ </div>
295
+ <div class="tags">
296
+
297
+ <p class="tag_title">Returns:</p>
298
+ <ul class="return">
299
+
300
+ <li>
301
+
302
+
303
+ <span class='type'>(<tt>JSON</tt>)</span>
304
+
305
+
306
+
307
+ &mdash;
308
+ <div class='inline'>
309
+ <p>The JSON object of the VirtualDataCenter Secret-Key</p>
310
+ </div>
311
+
312
+ </li>
313
+
314
+ </ul>
315
+
316
+ </div><table class="source_code">
317
+ <tr>
318
+ <td>
319
+ <pre class="lines">
320
+
321
+
322
+ 24
323
+ 25
324
+ 26</pre>
325
+ </td>
326
+ <td>
327
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/virtualdatacenter.rb', line 24</span>
328
+
329
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vdc_secretkey'>get_vdc_secretkey</span><span class='lparen'>(</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
330
+ <span class='id identifier rubyid_rest_get'>rest_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vdc/secret-key</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='ivar'>@auth_token</span> <span class='op'>:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='ivar'>@verify_cert</span> <span class='op'>:</span> <span class='id identifier rubyid_cert'>cert</span><span class='rparen'>)</span>
331
+ <span class='kw'>end</span></pre>
332
+ </td>
333
+ </tr>
334
+ </table>
335
+ </div>
336
+
337
+ <div class="method_details ">
338
+ <h3 class="signature " id="get_vdcs-instance_method">
339
+
340
+ - (<tt>json</tt>) <strong>get_vdcs</strong>(auth = nil, cert = nil)
341
+
342
+
343
+
344
+
345
+
346
+ </h3><div class="docstring">
347
+ <div class="discussion">
348
+
349
+ <p>Get All VirtualDataCenters</p>
350
+
351
+
352
+ </div>
353
+ </div>
354
+ <div class="tags">
355
+
356
+ <p class="tag_title">Returns:</p>
357
+ <ul class="return">
358
+
359
+ <li>
360
+
361
+
362
+ <span class='type'>(<tt>json</tt>)</span>
363
+
364
+
365
+
366
+ &mdash;
367
+ <div class='inline'>
368
+ <p>JSON object of all the VirtualDataCenters</p>
369
+ </div>
370
+
371
+ </li>
372
+
373
+ </ul>
374
+
375
+ </div><table class="source_code">
376
+ <tr>
377
+ <td>
378
+ <pre class="lines">
379
+
380
+
381
+ 8
382
+ 9
383
+ 10</pre>
384
+ </td>
385
+ <td>
386
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/virtualdatacenter.rb', line 8</span>
387
+
388
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vdcs'>get_vdcs</span><span class='lparen'>(</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
389
+ <span class='id identifier rubyid_rest_get'>rest_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vdc</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_auth'>auth</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='ivar'>@auth_token</span> <span class='op'>:</span> <span class='id identifier rubyid_auth'>auth</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='ivar'>@verify_cert</span> <span class='op'>:</span> <span class='id identifier rubyid_cert'>cert</span><span class='rparen'>)</span>
390
+ <span class='kw'>end</span></pre>
391
+ </td>
392
+ </tr>
393
+ </table>
394
+ </div>
395
+
396
+ </div>
397
+
398
+ </div>
399
+
400
+ <div id="footer">
401
+ Generated on Mon Jun 1 15:10:33 2015 by
402
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
403
+ 0.8.7.6 (ruby-2.1.2).
404
+ </div>
405
+
406
+ </body>
407
+ </html>
@@ -114,7 +114,7 @@
114
114
 
115
115
  </div>
116
116
  </dt>
117
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.6</span><span class='tstring_end'>&quot;</span></span></pre></dd>
117
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.7.2</span><span class='tstring_end'>&quot;</span></span></pre></dd>
118
118
 
119
119
  </dl>
120
120
 
@@ -130,7 +130,7 @@
130
130
  </div>
131
131
 
132
132
  <div id="footer">
133
- Generated on Mon Dec 15 13:52:44 2014 by
133
+ Generated on Mon Jun 1 15:10:33 2015 by
134
134
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135
135
  0.8.7.6 (ruby-2.1.2).
136
136
  </div>
@@ -89,26 +89,76 @@
89
89
 
90
90
  </li>
91
91
 
92
+ <li>
93
+ <span class='object_link'><a href="ViprAutoTier.html" title="ViprAutoTier (module)">ViprAutoTier</a></span>
94
+
95
+ </li>
96
+
92
97
  <li>
93
98
  <span class='object_link'><a href="ViprBase.html" title="ViprBase (module)">ViprBase</a></span>
94
99
 
95
100
  </li>
96
101
 
102
+ <li>
103
+ <span class='object_link'><a href="ViprBlockVirtualPool.html" title="ViprBlockVirtualPool (module)">ViprBlockVirtualPool</a></span>
104
+
105
+ </li>
106
+
107
+ <li>
108
+ <span class='object_link'><a href="ViprFileVirtualPool.html" title="ViprFileVirtualPool (module)">ViprFileVirtualPool</a></span>
109
+
110
+ </li>
111
+
97
112
  <li>
98
113
  <span class='object_link'><a href="ViprHost.html" title="ViprHost (module)">ViprHost</a></span>
99
114
 
100
115
  </li>
101
116
 
117
+ <li>
118
+ <span class='object_link'><a href="ViprServiceCatalog.html" title="ViprServiceCatalog (module)">ViprServiceCatalog</a></span>
119
+
120
+ </li>
121
+
122
+ <li>
123
+ <span class='object_link'><a href="ViprStoragePool.html" title="ViprStoragePool (module)">ViprStoragePool</a></span>
124
+
125
+ </li>
126
+
127
+ <li>
128
+ <span class='object_link'><a href="ViprStoragePort.html" title="ViprStoragePort (module)">ViprStoragePort</a></span>
129
+
130
+ </li>
131
+
102
132
  <li>
103
133
  <span class='object_link'><a href="ViprStorageSystem.html" title="ViprStorageSystem (module)">ViprStorageSystem</a></span>
104
134
 
105
135
  </li>
106
136
 
137
+ <li>
138
+ <span class='object_link'><a href="ViprStorageTier.html" title="ViprStorageTier (module)">ViprStorageTier</a></span>
139
+
140
+ </li>
141
+
142
+ <li>
143
+ <span class='object_link'><a href="ViprTenant.html" title="ViprTenant (module)">ViprTenant</a></span>
144
+
145
+ </li>
146
+
107
147
  <li>
108
148
  <span class='object_link'><a href="ViprVcenter.html" title="ViprVcenter (module)">ViprVcenter</a></span>
109
149
 
110
150
  </li>
111
151
 
152
+ <li>
153
+ <span class='object_link'><a href="ViprVirtualArray.html" title="ViprVirtualArray (module)">ViprVirtualArray</a></span>
154
+
155
+ </li>
156
+
157
+ <li>
158
+ <span class='object_link'><a href="ViprVirtualDataCenter.html" title="ViprVirtualDataCenter (module)">ViprVirtualDataCenter</a></span>
159
+
160
+ </li>
161
+
112
162
  <li>
113
163
  <span class='object_link'><a href="Vipruby.html" title="Vipruby (module)">Vipruby</a></span>
114
164
 
@@ -126,7 +176,7 @@
126
176
  </div>
127
177
 
128
178
  <div id="footer">
129
- Generated on Mon Dec 15 13:52:44 2014 by
179
+ Generated on Mon Jun 1 15:10:32 2015 by
130
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
131
181
  0.8.7.6 (ruby-2.1.2).
132
182
  </div>