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
data/doc/ViprStoragePool.html ADDED
@@ -0,0 +1,664 @@
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: ViprStoragePool
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#!ViprStoragePool.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">ViprStoragePool</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: ViprStoragePool
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/storagepool.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 StoragePool calls will get and execute StoragePool items</p>
95
+
96
+
97
+ </div>
98
+ </div>
99
+ <div class="tags">
100
+
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Instance Method Summary
112
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="private ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#check_storage_pool_id_post-instance_method" title="#check_storage_pool_id_post (instance method)">- (Boolean) <strong>check_storage_pool_id_post</strong>(storage_pool_id = nil) </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+ <span class="note title private">private</span>
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Error Handling method to check for Missing Storage Pool ID param.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#get_storage_pool-instance_method" title="#get_storage_pool (instance method)">- (JSON) <strong>get_storage_pool</strong>(storage_pool_id, auth = nil, cert = nil) </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Get single StoragePool Resources information.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#get_storage_pools-instance_method" title="#get_storage_pools (instance method)">- (json) <strong>get_storage_pools</strong>(auth = nil, cert = nil) </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'>
183
+ <p>Get All StoragePools.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#storage_pool_deactivate-instance_method" title="#storage_pool_deactivate (instance method)">- (JSON) <strong>storage_pool_deactivate</strong>(storage_pool_id = nil, auth = nil, cert = nil) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'>
207
+ <p>Deactivate StoragePool.</p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#storage_pool_deregister-instance_method" title="#storage_pool_deregister (instance method)">- (JSON) <strong>storage_pool_deregister</strong>(storage_pool_id = nil, auth = nil, cert = nil) </a>
217
+
218
+
219
+
220
+ </span>
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+ <span class="summary_desc"><div class='inline'>
231
+ <p>Deregister StoragePool.</p>
232
+ </div></span>
233
+
234
+ </li>
235
+
236
+
237
+ </ul>
238
+
239
+
240
+
241
+
242
+ <div id="instance_method_details" class="method_details_list">
243
+ <h2>Instance Method Details</h2>
244
+
245
+
246
+ <div class="method_details first">
247
+ <h3 class="signature first" id="check_storage_pool_id_post-instance_method">
248
+
249
+ - (<tt>Boolean</tt>) <strong>check_storage_pool_id_post</strong>(storage_pool_id = nil) <span class="extras">(private)</span>
250
+
251
+
252
+
253
+
254
+
255
+ </h3><div class="docstring">
256
+ <div class="discussion">
257
+
258
+ <p>Error Handling method to check for Missing Storage Pool ID param. If the
259
+ pass fails, an error exception is raised</p>
260
+
261
+
262
+ </div>
263
+ </div>
264
+ <div class="tags">
265
+ <p class="tag_title">Parameters:</p>
266
+ <ul class="param">
267
+
268
+ <li>
269
+
270
+ <span class='name'>storage_pool_id</span>
271
+
272
+
273
+ <span class='type'>(<tt>String</tt>)</span>
274
+
275
+
276
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
277
+
278
+
279
+ &mdash;
280
+ <div class='inline'>
281
+ <p>Requires the string of the storage_pool_id uid</p>
282
+ </div>
283
+
284
+ </li>
285
+
286
+ </ul>
287
+
288
+ <p class="tag_title">Returns:</p>
289
+ <ul class="return">
290
+
291
+ <li>
292
+
293
+
294
+ <span class='type'>(<tt>Boolean</tt>)</span>
295
+
296
+
297
+
298
+ &mdash;
299
+ <div class='inline'>
300
+ <p>True if pass, false if it fails</p>
301
+ </div>
302
+
303
+ </li>
304
+
305
+ </ul>
306
+
307
+ </div><table class="source_code">
308
+ <tr>
309
+ <td>
310
+ <pre class="lines">
311
+
312
+
313
+ 73
314
+ 74
315
+ 75
316
+ 76
317
+ 77</pre>
318
+ </td>
319
+ <td>
320
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagepool.rb', line 73</span>
321
+
322
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_storage_pool_id_post'>check_storage_pool_id_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
323
+ <span class='kw'>if</span> <span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span> <span class='op'>==</span> <span class='kw'>nil</span>
324
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing param (storage_pool_id)</span><span class='tstring_end'>&quot;</span></span>
325
+ <span class='kw'>end</span>
326
+ <span class='kw'>end</span></pre>
327
+ </td>
328
+ </tr>
329
+ </table>
330
+ </div>
331
+
332
+ <div class="method_details ">
333
+ <h3 class="signature " id="get_storage_pool-instance_method">
334
+
335
+ - (<tt>JSON</tt>) <strong>get_storage_pool</strong>(storage_pool_id, auth = nil, cert = nil)
336
+
337
+
338
+
339
+
340
+
341
+ </h3><div class="docstring">
342
+ <div class="discussion">
343
+
344
+ <p>Get single StoragePool Resources information</p>
345
+
346
+
347
+ </div>
348
+ </div>
349
+ <div class="tags">
350
+ <p class="tag_title">Parameters:</p>
351
+ <ul class="param">
352
+
353
+ <li>
354
+
355
+ <span class='name'>storage_pool_id</span>
356
+
357
+
358
+ <span class='type'>(<tt>urn:id</tt>)</span>
359
+
360
+
361
+
362
+ &mdash;
363
+ <div class='inline'>
364
+ <p>URN of a StoragePool. Required Param</p>
365
+ </div>
366
+
367
+ </li>
368
+
369
+ </ul>
370
+
371
+ <p class="tag_title">Returns:</p>
372
+ <ul class="return">
373
+
374
+ <li>
375
+
376
+
377
+ <span class='type'>(<tt>JSON</tt>)</span>
378
+
379
+
380
+
381
+ &mdash;
382
+ <div class='inline'>
383
+ <p>The JSON object of the StoragePool Resources</p>
384
+ </div>
385
+
386
+ </li>
387
+
388
+ </ul>
389
+
390
+ </div><table class="source_code">
391
+ <tr>
392
+ <td>
393
+ <pre class="lines">
394
+
395
+
396
+ 17
397
+ 18
398
+ 19</pre>
399
+ </td>
400
+ <td>
401
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagepool.rb', line 17</span>
402
+
403
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_storage_pool'>get_storage_pool</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_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>
404
+ <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/storage-pools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_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>
405
+ <span class='kw'>end</span></pre>
406
+ </td>
407
+ </tr>
408
+ </table>
409
+ </div>
410
+
411
+ <div class="method_details ">
412
+ <h3 class="signature " id="get_storage_pools-instance_method">
413
+
414
+ - (<tt>json</tt>) <strong>get_storage_pools</strong>(auth = nil, cert = nil)
415
+
416
+
417
+
418
+
419
+
420
+ </h3><div class="docstring">
421
+ <div class="discussion">
422
+
423
+ <p>Get All StoragePools</p>
424
+
425
+
426
+ </div>
427
+ </div>
428
+ <div class="tags">
429
+
430
+ <p class="tag_title">Returns:</p>
431
+ <ul class="return">
432
+
433
+ <li>
434
+
435
+
436
+ <span class='type'>(<tt>json</tt>)</span>
437
+
438
+
439
+
440
+ &mdash;
441
+ <div class='inline'>
442
+ <p>JSON object of all the StoragePools</p>
443
+ </div>
444
+
445
+ </li>
446
+
447
+ </ul>
448
+
449
+ </div><table class="source_code">
450
+ <tr>
451
+ <td>
452
+ <pre class="lines">
453
+
454
+
455
+ 8
456
+ 9
457
+ 10</pre>
458
+ </td>
459
+ <td>
460
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagepool.rb', line 8</span>
461
+
462
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_storage_pools'>get_storage_pools</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>
463
+ <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/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>
464
+ <span class='kw'>end</span></pre>
465
+ </td>
466
+ </tr>
467
+ </table>
468
+ </div>
469
+
470
+ <div class="method_details ">
471
+ <h3 class="signature " id="storage_pool_deactivate-instance_method">
472
+
473
+ - (<tt>JSON</tt>) <strong>storage_pool_deactivate</strong>(storage_pool_id = nil, auth = nil, cert = nil)
474
+
475
+
476
+
477
+
478
+
479
+ </h3><div class="docstring">
480
+ <div class="discussion">
481
+
482
+ <p>Deactivate StoragePool. Remove a storage pool. The method would remove the
483
+ deregistered storage pool and all resources associated with the storage
484
+ pool from the database. Note they are not removed from the storage system
485
+ physically, but become unavailable for the user.</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'>storage_pool_id</span>
497
+
498
+
499
+ <span class='type'>(<tt>urn:id</tt>)</span>
500
+
501
+
502
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
503
+
504
+
505
+ &mdash;
506
+ <div class='inline'>
507
+ <p>URN of a StoragePool. Required Param</p>
508
+ </div>
509
+
510
+ </li>
511
+
512
+ </ul>
513
+
514
+ <p class="tag_title">Returns:</p>
515
+ <ul class="return">
516
+
517
+ <li>
518
+
519
+
520
+ <span class='type'>(<tt>JSON</tt>)</span>
521
+
522
+
523
+
524
+ &mdash;
525
+ <div class='inline'>
526
+ <p>The JSON object of the StoragePool</p>
527
+ </div>
528
+
529
+ </li>
530
+
531
+ </ul>
532
+
533
+ </div><table class="source_code">
534
+ <tr>
535
+ <td>
536
+ <pre class="lines">
537
+
538
+
539
+ 57
540
+ 58
541
+ 59
542
+ 60
543
+ 61
544
+ 62
545
+ 63</pre>
546
+ </td>
547
+ <td>
548
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagepool.rb', line 57</span>
549
+
550
+ <span class='kw'>def</span> <span class='id identifier rubyid_storage_pool_deactivate'>storage_pool_deactivate</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_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>
551
+ <span class='id identifier rubyid_check_storage_pool_id_post'>check_storage_pool_id_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span><span class='rparen'>)</span>
552
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
553
+ <span class='label'>id:</span> <span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span>
554
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
555
+ <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'>/vdc/storage-pools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_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>
556
+ <span class='kw'>end</span></pre>
557
+ </td>
558
+ </tr>
559
+ </table>
560
+ </div>
561
+
562
+ <div class="method_details ">
563
+ <h3 class="signature " id="storage_pool_deregister-instance_method">
564
+
565
+ - (<tt>JSON</tt>) <strong>storage_pool_deregister</strong>(storage_pool_id = nil, auth = nil, cert = nil)
566
+
567
+
568
+
569
+
570
+
571
+ </h3><div class="docstring">
572
+ <div class="discussion">
573
+
574
+ <p>Deregister StoragePool. Allows the user to deregister a registered storage
575
+ pool so that it is no longer used by the system. This simply sets the
576
+ registration_status of the storage pool to UNREGISTERED</p>
577
+
578
+
579
+ </div>
580
+ </div>
581
+ <div class="tags">
582
+ <p class="tag_title">Parameters:</p>
583
+ <ul class="param">
584
+
585
+ <li>
586
+
587
+ <span class='name'>storage_pool_id</span>
588
+
589
+
590
+ <span class='type'>(<tt>urn:id</tt>)</span>
591
+
592
+
593
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
594
+
595
+
596
+ &mdash;
597
+ <div class='inline'>
598
+ <p>URN of a StoragePool. Required Param</p>
599
+ </div>
600
+
601
+ </li>
602
+
603
+ </ul>
604
+
605
+ <p class="tag_title">Returns:</p>
606
+ <ul class="return">
607
+
608
+ <li>
609
+
610
+
611
+ <span class='type'>(<tt>JSON</tt>)</span>
612
+
613
+
614
+
615
+ &mdash;
616
+ <div class='inline'>
617
+ <p>The JSON object of the StoragePool</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ </ul>
623
+
624
+ </div><table class="source_code">
625
+ <tr>
626
+ <td>
627
+ <pre class="lines">
628
+
629
+
630
+ 44
631
+ 45
632
+ 46
633
+ 47
634
+ 48
635
+ 49
636
+ 50</pre>
637
+ </td>
638
+ <td>
639
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagepool.rb', line 44</span>
640
+
641
+ <span class='kw'>def</span> <span class='id identifier rubyid_storage_pool_deregister'>storage_pool_deregister</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_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>
642
+ <span class='id identifier rubyid_check_storage_pool_id_post'>check_storage_pool_id_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span><span class='rparen'>)</span>
643
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
644
+ <span class='label'>id:</span> <span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span>
645
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
646
+ <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'>/vdc/storage-pools/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_storage_pool_id'>storage_pool_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deregister</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>
647
+ <span class='kw'>end</span></pre>
648
+ </td>
649
+ </tr>
650
+ </table>
651
+ </div>
652
+
653
+ </div>
654
+
655
+ </div>
656
+
657
+ <div id="footer">
658
+ Generated on Mon Jun 1 15:10:33 2015 by
659
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
660
+ 0.8.7.6 (ruby-2.1.2).
661
+ </div>
662
+
663
+ </body>
664
+ </html>