vipruby 0.1.7 → 0.1.7.2

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -919,7 +919,7 @@ href="0">object</a> or <a href="'id'">object</a> notation</p>
919
919
  </div>
920
920
 
921
921
  <div id="footer">
922
- Generated on Mon Dec 15 13:52:44 2014 by
922
+ Generated on Mon Jun 1 15:10:33 2015 by
923
923
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
924
924
  0.8.7.6 (ruby-2.1.2).
925
925
  </div>
@@ -0,0 +1,859 @@
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: ViprBlockVirtualPool
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#!ViprBlockVirtualPool.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">ViprBlockVirtualPool</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: ViprBlockVirtualPool
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/blockvirtualpool.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 Block Virtual Pool calls will get and execute Block Virtual
95
+ Pool 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="#block_vpool_deactivate-instance_method" title="#block_vpool_deactivate (instance method)">- (JSON) <strong>block_vpool_deactivate</strong>(block_vpool_id = nil, 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>Deactivate Block Virtual Pool.</p>
137
+ </div></span>
138
+
139
+ </li>
140
+
141
+
142
+ <li class="private ">
143
+ <span class="summary_signature">
144
+
145
+ <a href="#check_block_vpool_id_post-instance_method" title="#check_block_vpool_id_post (instance method)">- (Boolean) <strong>check_block_vpool_id_post</strong>(block_vpool_id = nil) </a>
146
+
147
+
148
+
149
+ </span>
150
+
151
+
152
+
153
+ <span class="note title private">private</span>
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'>
160
+ <p>Error Handling method to check for Block Virtual Pool ID param.</p>
161
+ </div></span>
162
+
163
+ </li>
164
+
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#get_block_vpool-instance_method" title="#get_block_vpool (instance method)">- (JSON) <strong>get_block_vpool</strong>(block_vpool_id, 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 Single Block Virtual Pool information.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ <li class="public ">
191
+ <span class="summary_signature">
192
+
193
+ <a href="#get_block_vpool_acl-instance_method" title="#get_block_vpool_acl (instance method)">- (JSON) <strong>get_block_vpool_acl</strong>(block_vpool_id, auth = nil, cert = nil) </a>
194
+
195
+
196
+
197
+ </span>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+ <span class="summary_desc"><div class='inline'>
208
+ <p>Get Single Block Virtual Pool ACL information.</p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#get_block_vpool_refresh_matched_pools-instance_method" title="#get_block_vpool_refresh_matched_pools (instance method)">- (JSON) <strong>get_block_vpool_refresh_matched_pools</strong>(block_vpool_id, auth = nil, cert = nil) </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'>
232
+ <p>Regresh Single Block Virtual Pool Matched Pools information.</p>
233
+ </div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#get_block_vpool_storage_pools-instance_method" title="#get_block_vpool_storage_pools (instance method)">- (JSON) <strong>get_block_vpool_storage_pools</strong>(block_vpool_id, auth = nil, cert = nil) </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'>
256
+ <p>Get Single Block Virtual Pool Storage Pools information.</p>
257
+ </div></span>
258
+
259
+ </li>
260
+
261
+
262
+ <li class="public ">
263
+ <span class="summary_signature">
264
+
265
+ <a href="#get_block_vpools-instance_method" title="#get_block_vpools (instance method)">- (json) <strong>get_block_vpools</strong>(auth = nil, cert = nil) </a>
266
+
267
+
268
+
269
+ </span>
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+ <span class="summary_desc"><div class='inline'>
280
+ <p>Get All Block Virtual Pools.</p>
281
+ </div></span>
282
+
283
+ </li>
284
+
285
+
286
+ </ul>
287
+
288
+
289
+
290
+
291
+ <div id="instance_method_details" class="method_details_list">
292
+ <h2>Instance Method Details</h2>
293
+
294
+
295
+ <div class="method_details first">
296
+ <h3 class="signature first" id="block_vpool_deactivate-instance_method">
297
+
298
+ - (<tt>JSON</tt>) <strong>block_vpool_deactivate</strong>(block_vpool_id = nil, auth = nil, cert = nil)
299
+
300
+
301
+
302
+
303
+
304
+ </h3><div class="docstring">
305
+ <div class="discussion">
306
+
307
+ <p>Deactivate Block Virtual Pool. Deactivate block store virtual pool, this
308
+ will move the virtual pool to a “marked-for-deletion” state, and no more
309
+ resource may be created using it. The virtual pool will be deleted when all
310
+ references to this virtual pool of type Volume are deleted</p>
311
+
312
+
313
+ </div>
314
+ </div>
315
+ <div class="tags">
316
+ <p class="tag_title">Parameters:</p>
317
+ <ul class="param">
318
+
319
+ <li>
320
+
321
+ <span class='name'>block_vpool_id</span>
322
+
323
+
324
+ <span class='type'>(<tt>urn:id</tt>)</span>
325
+
326
+
327
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
328
+
329
+
330
+ &mdash;
331
+ <div class='inline'>
332
+ <p>URN of a Block Virtual Pool. Required Param</p>
333
+ </div>
334
+
335
+ </li>
336
+
337
+ </ul>
338
+
339
+ <p class="tag_title">Returns:</p>
340
+ <ul class="return">
341
+
342
+ <li>
343
+
344
+
345
+ <span class='type'>(<tt>JSON</tt>)</span>
346
+
347
+
348
+
349
+ &mdash;
350
+ <div class='inline'>
351
+ <p>The JSON object of the Block Virtual Pool</p>
352
+ </div>
353
+
354
+ </li>
355
+
356
+ </ul>
357
+
358
+ </div><table class="source_code">
359
+ <tr>
360
+ <td>
361
+ <pre class="lines">
362
+
363
+
364
+ 62
365
+ 63
366
+ 64
367
+ 65
368
+ 66
369
+ 67
370
+ 68</pre>
371
+ </td>
372
+ <td>
373
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 62</span>
374
+
375
+ <span class='kw'>def</span> <span class='id identifier rubyid_block_vpool_deactivate'>block_vpool_deactivate</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='op'>=</span><span class='kw'>nil</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>
376
+ <span class='id identifier rubyid_check_block_vpool_id_post'>check_block_vpool_id_post</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='rparen'>)</span>
377
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
378
+ <span class='label'>id:</span> <span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span>
379
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
380
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</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'>/block/vpools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deactivate</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>
381
+ <span class='kw'>end</span></pre>
382
+ </td>
383
+ </tr>
384
+ </table>
385
+ </div>
386
+
387
+ <div class="method_details ">
388
+ <h3 class="signature " id="check_block_vpool_id_post-instance_method">
389
+
390
+ - (<tt>Boolean</tt>) <strong>check_block_vpool_id_post</strong>(block_vpool_id = nil) <span class="extras">(private)</span>
391
+
392
+
393
+
394
+
395
+
396
+ </h3><div class="docstring">
397
+ <div class="discussion">
398
+
399
+ <p>Error Handling method to check for Block Virtual Pool ID param. If the pass
400
+ fails, an error exception is raised</p>
401
+
402
+
403
+ </div>
404
+ </div>
405
+ <div class="tags">
406
+ <p class="tag_title">Parameters:</p>
407
+ <ul class="param">
408
+
409
+ <li>
410
+
411
+ <span class='name'>block_vpool_id</span>
412
+
413
+
414
+ <span class='type'>(<tt>String</tt>)</span>
415
+
416
+
417
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
418
+
419
+
420
+ &mdash;
421
+ <div class='inline'>
422
+ <p>Requires the string of the block_vpool_id uid</p>
423
+ </div>
424
+
425
+ </li>
426
+
427
+ </ul>
428
+
429
+ <p class="tag_title">Returns:</p>
430
+ <ul class="return">
431
+
432
+ <li>
433
+
434
+
435
+ <span class='type'>(<tt>Boolean</tt>)</span>
436
+
437
+
438
+
439
+ &mdash;
440
+ <div class='inline'>
441
+ <p>True if pass, false if it fails</p>
442
+ </div>
443
+
444
+ </li>
445
+
446
+ </ul>
447
+
448
+ </div><table class="source_code">
449
+ <tr>
450
+ <td>
451
+ <pre class="lines">
452
+
453
+
454
+ 77
455
+ 78
456
+ 79
457
+ 80
458
+ 81</pre>
459
+ </td>
460
+ <td>
461
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 77</span>
462
+
463
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_block_vpool_id_post'>check_block_vpool_id_post</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
464
+ <span class='kw'>if</span> <span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span> <span class='op'>==</span> <span class='kw'>nil</span>
465
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing param (block_vpool_id)</span><span class='tstring_end'>&quot;</span></span>
466
+ <span class='kw'>end</span>
467
+ <span class='kw'>end</span></pre>
468
+ </td>
469
+ </tr>
470
+ </table>
471
+ </div>
472
+
473
+ <div class="method_details ">
474
+ <h3 class="signature " id="get_block_vpool-instance_method">
475
+
476
+ - (<tt>JSON</tt>) <strong>get_block_vpool</strong>(block_vpool_id, auth = nil, cert = nil)
477
+
478
+
479
+
480
+
481
+
482
+ </h3><div class="docstring">
483
+ <div class="discussion">
484
+
485
+ <p>Get Single Block Virtual Pool information</p>
486
+
487
+
488
+ </div>
489
+ </div>
490
+ <div class="tags">
491
+ <p class="tag_title">Parameters:</p>
492
+ <ul class="param">
493
+
494
+ <li>
495
+
496
+ <span class='name'>block_vpool_id</span>
497
+
498
+
499
+ <span class='type'>(<tt>urn:id</tt>)</span>
500
+
501
+
502
+
503
+ &mdash;
504
+ <div class='inline'>
505
+ <p>URN of a Block Virtual Pool. Required Param</p>
506
+ </div>
507
+
508
+ </li>
509
+
510
+ </ul>
511
+
512
+ <p class="tag_title">Returns:</p>
513
+ <ul class="return">
514
+
515
+ <li>
516
+
517
+
518
+ <span class='type'>(<tt>JSON</tt>)</span>
519
+
520
+
521
+
522
+ &mdash;
523
+ <div class='inline'>
524
+ <p>The JSON object of the Block Virtual Pool</p>
525
+ </div>
526
+
527
+ </li>
528
+
529
+ </ul>
530
+
531
+ </div><table class="source_code">
532
+ <tr>
533
+ <td>
534
+ <pre class="lines">
535
+
536
+
537
+ 17
538
+ 18
539
+ 19</pre>
540
+ </td>
541
+ <td>
542
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 17</span>
543
+
544
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_block_vpool'>get_block_vpool</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_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>
545
+ <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'>/block/vpools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_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>
546
+ <span class='kw'>end</span></pre>
547
+ </td>
548
+ </tr>
549
+ </table>
550
+ </div>
551
+
552
+ <div class="method_details ">
553
+ <h3 class="signature " id="get_block_vpool_acl-instance_method">
554
+
555
+ - (<tt>JSON</tt>) <strong>get_block_vpool_acl</strong>(block_vpool_id, auth = nil, cert = nil)
556
+
557
+
558
+
559
+
560
+
561
+ </h3><div class="docstring">
562
+ <div class="discussion">
563
+
564
+ <p>Get Single Block Virtual Pool ACL information</p>
565
+
566
+
567
+ </div>
568
+ </div>
569
+ <div class="tags">
570
+ <p class="tag_title">Parameters:</p>
571
+ <ul class="param">
572
+
573
+ <li>
574
+
575
+ <span class='name'>block_vpool_id</span>
576
+
577
+
578
+ <span class='type'>(<tt>urn:id</tt>)</span>
579
+
580
+
581
+
582
+ &mdash;
583
+ <div class='inline'>
584
+ <p>URN of a Block Virtual Pool. Required Param</p>
585
+ </div>
586
+
587
+ </li>
588
+
589
+ </ul>
590
+
591
+ <p class="tag_title">Returns:</p>
592
+ <ul class="return">
593
+
594
+ <li>
595
+
596
+
597
+ <span class='type'>(<tt>JSON</tt>)</span>
598
+
599
+
600
+
601
+ &mdash;
602
+ <div class='inline'>
603
+ <p>The JSON object of the Block Virtual Pool ACL</p>
604
+ </div>
605
+
606
+ </li>
607
+
608
+ </ul>
609
+
610
+ </div><table class="source_code">
611
+ <tr>
612
+ <td>
613
+ <pre class="lines">
614
+
615
+
616
+ 26
617
+ 27
618
+ 28</pre>
619
+ </td>
620
+ <td>
621
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 26</span>
622
+
623
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_block_vpool_acl'>get_block_vpool_acl</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_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>
624
+ <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'>/block/vpools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/acl</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>
625
+ <span class='kw'>end</span></pre>
626
+ </td>
627
+ </tr>
628
+ </table>
629
+ </div>
630
+
631
+ <div class="method_details ">
632
+ <h3 class="signature " id="get_block_vpool_refresh_matched_pools-instance_method">
633
+
634
+ - (<tt>JSON</tt>) <strong>get_block_vpool_refresh_matched_pools</strong>(block_vpool_id, auth = nil, cert = nil)
635
+
636
+
637
+
638
+
639
+
640
+ </h3><div class="docstring">
641
+ <div class="discussion">
642
+
643
+ <p>Regresh Single Block Virtual Pool Matched Pools information</p>
644
+
645
+
646
+ </div>
647
+ </div>
648
+ <div class="tags">
649
+ <p class="tag_title">Parameters:</p>
650
+ <ul class="param">
651
+
652
+ <li>
653
+
654
+ <span class='name'>block_vpool_id</span>
655
+
656
+
657
+ <span class='type'>(<tt>urn:id</tt>)</span>
658
+
659
+
660
+
661
+ &mdash;
662
+ <div class='inline'>
663
+ <p>URN of a Block Virtual Pool. Required Param</p>
664
+ </div>
665
+
666
+ </li>
667
+
668
+ </ul>
669
+
670
+ <p class="tag_title">Returns:</p>
671
+ <ul class="return">
672
+
673
+ <li>
674
+
675
+
676
+ <span class='type'>(<tt>JSON</tt>)</span>
677
+
678
+
679
+
680
+ &mdash;
681
+ <div class='inline'>
682
+ <p>The JSON object of the Block Virtual Pool Storage Pools</p>
683
+ </div>
684
+
685
+ </li>
686
+
687
+ </ul>
688
+
689
+ </div><table class="source_code">
690
+ <tr>
691
+ <td>
692
+ <pre class="lines">
693
+
694
+
695
+ 44
696
+ 45
697
+ 46</pre>
698
+ </td>
699
+ <td>
700
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 44</span>
701
+
702
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_block_vpool_refresh_matched_pools'>get_block_vpool_refresh_matched_pools</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_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>
703
+ <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'>/block/vpools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/refresh-matched-pools</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>
704
+ <span class='kw'>end</span></pre>
705
+ </td>
706
+ </tr>
707
+ </table>
708
+ </div>
709
+
710
+ <div class="method_details ">
711
+ <h3 class="signature " id="get_block_vpool_storage_pools-instance_method">
712
+
713
+ - (<tt>JSON</tt>) <strong>get_block_vpool_storage_pools</strong>(block_vpool_id, auth = nil, cert = nil)
714
+
715
+
716
+
717
+
718
+
719
+ </h3><div class="docstring">
720
+ <div class="discussion">
721
+
722
+ <p>Get Single Block Virtual Pool Storage Pools information</p>
723
+
724
+
725
+ </div>
726
+ </div>
727
+ <div class="tags">
728
+ <p class="tag_title">Parameters:</p>
729
+ <ul class="param">
730
+
731
+ <li>
732
+
733
+ <span class='name'>block_vpool_id</span>
734
+
735
+
736
+ <span class='type'>(<tt>urn:id</tt>)</span>
737
+
738
+
739
+
740
+ &mdash;
741
+ <div class='inline'>
742
+ <p>URN of a Block Virtual Pool. Required Param</p>
743
+ </div>
744
+
745
+ </li>
746
+
747
+ </ul>
748
+
749
+ <p class="tag_title">Returns:</p>
750
+ <ul class="return">
751
+
752
+ <li>
753
+
754
+
755
+ <span class='type'>(<tt>JSON</tt>)</span>
756
+
757
+
758
+
759
+ &mdash;
760
+ <div class='inline'>
761
+ <p>The JSON object of the Block Virtual Pool Storage Pools</p>
762
+ </div>
763
+
764
+ </li>
765
+
766
+ </ul>
767
+
768
+ </div><table class="source_code">
769
+ <tr>
770
+ <td>
771
+ <pre class="lines">
772
+
773
+
774
+ 35
775
+ 36
776
+ 37</pre>
777
+ </td>
778
+ <td>
779
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 35</span>
780
+
781
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_block_vpool_storage_pools'>get_block_vpool_storage_pools</span><span class='lparen'>(</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_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>
782
+ <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'>/block/vpools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_block_vpool_id'>block_vpool_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/storage-pools</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>
783
+ <span class='kw'>end</span></pre>
784
+ </td>
785
+ </tr>
786
+ </table>
787
+ </div>
788
+
789
+ <div class="method_details ">
790
+ <h3 class="signature " id="get_block_vpools-instance_method">
791
+
792
+ - (<tt>json</tt>) <strong>get_block_vpools</strong>(auth = nil, cert = nil)
793
+
794
+
795
+
796
+
797
+
798
+ </h3><div class="docstring">
799
+ <div class="discussion">
800
+
801
+ <p>Get All Block Virtual Pools</p>
802
+
803
+
804
+ </div>
805
+ </div>
806
+ <div class="tags">
807
+
808
+ <p class="tag_title">Returns:</p>
809
+ <ul class="return">
810
+
811
+ <li>
812
+
813
+
814
+ <span class='type'>(<tt>json</tt>)</span>
815
+
816
+
817
+
818
+ &mdash;
819
+ <div class='inline'>
820
+ <p>JSON object of all the Block Virtual Pools</p>
821
+ </div>
822
+
823
+ </li>
824
+
825
+ </ul>
826
+
827
+ </div><table class="source_code">
828
+ <tr>
829
+ <td>
830
+ <pre class="lines">
831
+
832
+
833
+ 8
834
+ 9
835
+ 10</pre>
836
+ </td>
837
+ <td>
838
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/blockvirtualpool.rb', line 8</span>
839
+
840
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_block_vpools'>get_block_vpools</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>
841
+ <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'>/block/vpools</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>
842
+ <span class='kw'>end</span></pre>
843
+ </td>
844
+ </tr>
845
+ </table>
846
+ </div>
847
+
848
+ </div>
849
+
850
+ </div>
851
+
852
+ <div id="footer">
853
+ Generated on Mon Jun 1 15:10:33 2015 by
854
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
855
+ 0.8.7.6 (ruby-2.1.2).
856
+ </div>
857
+
858
+ </body>
859
+ </html>