vipruby 0.1.4 → 0.1.6.1

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 (51) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -0
  3. data/.yardoc/checksums +7 -0
  4. data/.yardoc/object_types +0 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/.yardopts +1 -0
  8. data/Gemfile +4 -0
  9. data/Gemfile.lock +22 -0
  10. data/LICENSE.txt +22 -0
  11. data/README.md +49 -0
  12. data/Rakefile +2 -0
  13. data/doc/Host.html +910 -0
  14. data/doc/Vipr.html +656 -0
  15. data/doc/ViprBase.html +928 -0
  16. data/doc/ViprHost.html +1952 -0
  17. data/doc/ViprStorageSystem.html +2695 -0
  18. data/doc/ViprVcenter.html +1540 -0
  19. data/doc/Vipruby.html +139 -0
  20. data/doc/Vipruby/Auth.html +745 -0
  21. data/doc/_index.html +135 -0
  22. data/doc/class_list.html +58 -0
  23. data/doc/css/common.css +1 -0
  24. data/doc/css/full_list.css +57 -0
  25. data/doc/css/style.css +339 -0
  26. data/doc/file.README.html +121 -0
  27. data/doc/file_list.html +60 -0
  28. data/doc/frames.html +26 -0
  29. data/doc/index.html +121 -0
  30. data/doc/js/app.js +219 -0
  31. data/doc/js/full_list.js +181 -0
  32. data/doc/js/jquery.js +4 -0
  33. data/doc/method_list.html +333 -0
  34. data/doc/top-level-namespace.html +114 -0
  35. data/lib/.yardoc/checksums +0 -0
  36. data/lib/.yardoc/object_types +0 -0
  37. data/lib/.yardoc/objects/root.dat +0 -0
  38. data/lib/.yardoc/proxy_types +0 -0
  39. data/lib/vipruby.rb +6 -426
  40. data/lib/vipruby/.yardoc/checksums +0 -0
  41. data/lib/vipruby/.yardoc/object_types +0 -0
  42. data/lib/vipruby/.yardoc/objects/root.dat +0 -0
  43. data/lib/vipruby/.yardoc/proxy_types +0 -0
  44. data/lib/vipruby/objects/host.rb +234 -0
  45. data/lib/vipruby/objects/storagesystem.rb +278 -0
  46. data/lib/vipruby/objects/vcenter.rb +162 -0
  47. data/lib/vipruby/version.rb +6 -0
  48. data/lib/vipruby/vipr.rb +45 -0
  49. data/lib/vipruby/viprbase.rb +84 -0
  50. data/vipruby.gemspec +29 -0
  51. metadata +100 -9
data/doc/ViprVcenter.html ADDED
@@ -0,0 +1,1540 @@
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: ViprVcenter
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#!ViprVcenter.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">ViprVcenter</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: ViprVcenter
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/vcenter.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 vCenter calls will get vCenter information for all tenants</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="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#add_vcenter-instance_method" title="#add_vcenter (instance method)">- (Hash) <strong>add_vcenter</strong>(fqdn_or_ip = nil, name = nil, user_name = nil, password = nil, port = nil, tenant = nil, auth = nil, cert = nil) </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Add a vCenters to a specified tenant.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ <li class="private ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#check_vcenter-instance_method" title="#check_vcenter (instance method)">- (Boolean) <strong>check_vcenter</strong>(vcenter_id = nil) </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+ <span class="note title private">private</span>
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Error Handling method to check for Missing vCenter ID param.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="private ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#check_vcenter_object_hash-instance_method" title="#check_vcenter_object_hash (instance method)">- (Boolean) <strong>check_vcenter_object_hash</strong>(vcenter_search_hash = nil) </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+ <span class="note title private">private</span>
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'>
183
+ <p>Error Handling method to check for Missing vCenter Object param.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="private ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#check_vcenter_post-instance_method" title="#check_vcenter_post (instance method)">- (Boolean) <strong>check_vcenter_post</strong>(fqdn_or_ip = nil, name = nil, user_name = nil, password = nil) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+ <span class="note title private">private</span>
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'>
207
+ <p>Error Handling method to check for Missing Param.</p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#delete_vcenter-instance_method" title="#delete_vcenter (instance method)">- (Hash) <strong>delete_vcenter</strong>(vcenter_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>Delete a vCenter from any tenant based on vCenter ID.</p>
232
+ </div></span>
233
+
234
+ </li>
235
+
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#find_vcenter_object-instance_method" title="#find_vcenter_object (instance method)">- (Hash) <strong>find_vcenter_object</strong>(vcenter_search_hash = nil, auth = nil, cert = nil) </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ <span class="summary_desc"><div class='inline'>
255
+ <p>Search for vCenters matching a specific parameter.</p>
256
+ </div></span>
257
+
258
+ </li>
259
+
260
+
261
+ <li class="public ">
262
+ <span class="summary_signature">
263
+
264
+ <a href="#get_all_vcenters-instance_method" title="#get_all_vcenters (instance method)">- (Hash) <strong>get_all_vcenters</strong>(auth = nil, cert = nil) </a>
265
+
266
+
267
+
268
+ </span>
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <span class="summary_desc"><div class='inline'>
279
+ <p>Retrive all vCenter Servers registered for all tenants.</p>
280
+ </div></span>
281
+
282
+ </li>
283
+
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#get_vcenter-instance_method" title="#get_vcenter (instance method)">- (Hash) <strong>get_vcenter</strong>(vcenter_id = nil, auth = nil, cert = nil) </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <span class="summary_desc"><div class='inline'>
303
+ <p>Retrieve information for a single vCenter server using the uid.</p>
304
+ </div></span>
305
+
306
+ </li>
307
+
308
+
309
+ <li class="public ">
310
+ <span class="summary_signature">
311
+
312
+ <a href="#get_vcenter_clusters-instance_method" title="#get_vcenter_clusters (instance method)">- (Hash) <strong>get_vcenter_clusters</strong>(vcenter_id = nil, auth = nil, cert = nil) </a>
313
+
314
+
315
+
316
+ </span>
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <span class="summary_desc"><div class='inline'>
327
+ <p>Retrieve Cluster information for a single vCenter server using the uid.</p>
328
+ </div></span>
329
+
330
+ </li>
331
+
332
+
333
+ <li class="public ">
334
+ <span class="summary_signature">
335
+
336
+ <a href="#get_vcenter_datacenters-instance_method" title="#get_vcenter_datacenters (instance method)">- (Hash) <strong>get_vcenter_datacenters</strong>(vcenter_id = nil, auth = nil, cert = nil) </a>
337
+
338
+
339
+
340
+ </span>
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+ <span class="summary_desc"><div class='inline'>
351
+ <p>Retrieve Datacenter information for a single vCenter server using the uid.</p>
352
+ </div></span>
353
+
354
+ </li>
355
+
356
+
357
+ <li class="public ">
358
+ <span class="summary_signature">
359
+
360
+ <a href="#get_vcenter_hosts-instance_method" title="#get_vcenter_hosts (instance method)">- (Hash) <strong>get_vcenter_hosts</strong>(vcenter_id = nil, auth = nil, cert = nil) </a>
361
+
362
+
363
+
364
+ </span>
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+ <span class="summary_desc"><div class='inline'>
375
+ <p>Retrieve Host information for a single vCenter server using the uid.</p>
376
+ </div></span>
377
+
378
+ </li>
379
+
380
+
381
+ </ul>
382
+
383
+
384
+
385
+
386
+ <div id="instance_method_details" class="method_details_list">
387
+ <h2>Instance Method Details</h2>
388
+
389
+
390
+ <div class="method_details first">
391
+ <h3 class="signature first" id="add_vcenter-instance_method">
392
+
393
+ - (<tt>Hash</tt>) <strong>add_vcenter</strong>(fqdn_or_ip = nil, name = nil, user_name = nil, password = nil, port = nil, tenant = nil, auth = nil, cert = nil)
394
+
395
+
396
+
397
+
398
+
399
+ </h3><div class="docstring">
400
+ <div class="discussion">
401
+
402
+ <p>Add a vCenters to a specified tenant</p>
403
+
404
+
405
+ </div>
406
+ </div>
407
+ <div class="tags">
408
+
409
+ <div class="examples">
410
+ <p class="tag_title">Examples:</p>
411
+
412
+
413
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_vcenter'>add_vcenter</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vcenter1.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vCENTER1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DOMAIN\user</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>userpw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
414
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_vcenter'>add_vcenter</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vcenter2.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vCENTER2</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DOMAIN\user</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>userpw</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1092</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
415
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_vcenter'>add_vcenter</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vcenter3.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vCENTER3</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DOMAIN\user</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>userpw</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>diff_tenant_uid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
416
+
417
+ </div>
418
+ <p class="tag_title">Parameters:</p>
419
+ <ul class="param">
420
+
421
+ <li>
422
+
423
+ <span class='name'>fqdn_or_ip</span>
424
+
425
+
426
+ <span class='type'>(<tt>String</tt>)</span>
427
+
428
+
429
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
430
+
431
+
432
+ &mdash;
433
+ <div class='inline'>
434
+ <p>FQDN or IP Address of the vCenter server to add. This is a required string.</p>
435
+ </div>
436
+
437
+ </li>
438
+
439
+ <li>
440
+
441
+ <span class='name'>name</span>
442
+
443
+
444
+ <span class='type'>(<tt>String</tt>)</span>
445
+
446
+
447
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
448
+
449
+
450
+ &mdash;
451
+ <div class='inline'>
452
+ <p>Name of the vCenter server. This name is arbitrary and only exists within
453
+ ViPR. This is a required string.</p>
454
+ </div>
455
+
456
+ </li>
457
+
458
+ <li>
459
+
460
+ <span class='name'>user_name</span>
461
+
462
+
463
+ <span class='type'>(<tt>String</tt>)</span>
464
+
465
+
466
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
467
+
468
+
469
+ &mdash;
470
+ <div class='inline'>
471
+ <p>User Name that will be used for authenticating against the vCenter Server.
472
+ This is a required string.</p>
473
+ </div>
474
+
475
+ </li>
476
+
477
+ <li>
478
+
479
+ <span class='name'>password</span>
480
+
481
+
482
+ <span class='type'>(<tt>String</tt>)</span>
483
+
484
+
485
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
486
+
487
+
488
+ &mdash;
489
+ <div class='inline'>
490
+ <p>Password for the user_name that will be used for authenticating against the
491
+ vCenter Server. This is a required string.</p>
492
+ </div>
493
+
494
+ </li>
495
+
496
+ <li>
497
+
498
+ <span class='name'>port</span>
499
+
500
+
501
+ <span class='type'>(<tt>String</tt>)</span>
502
+
503
+
504
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
505
+
506
+
507
+ &mdash;
508
+ <div class='inline'>
509
+ <p>Port of the vCenter server. This is an optional parameter. If no parameter
510
+ is present, the default port of &#39;443&#39; will be used. If registering
511
+ to a different tenant than default, set this param to nil</p>
512
+ </div>
513
+
514
+ </li>
515
+
516
+ <li>
517
+
518
+ <span class='name'>tenant</span>
519
+
520
+
521
+ <span class='type'>(<tt>String</tt>)</span>
522
+
523
+
524
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
525
+
526
+
527
+ &mdash;
528
+ <div class='inline'>
529
+ <p>Specify a tenant_uid where the vCenter will be registered. By default it
530
+ will be added to the tenant of the current logged in ViPR user. This string
531
+ is optional.</p>
532
+ </div>
533
+
534
+ </li>
535
+
536
+ </ul>
537
+
538
+ <p class="tag_title">Returns:</p>
539
+ <ul class="return">
540
+
541
+ <li>
542
+
543
+
544
+ <span class='type'>(<tt>Hash</tt>)</span>
545
+
546
+
547
+
548
+ &mdash;
549
+ <div class='inline'>
550
+ <p>The resulted post operation</p>
551
+ </div>
552
+
553
+ </li>
554
+
555
+ </ul>
556
+
557
+ </div><table class="source_code">
558
+ <tr>
559
+ <td>
560
+ <pre class="lines">
561
+
562
+
563
+ 92
564
+ 93
565
+ 94
566
+ 95
567
+ 96
568
+ 97
569
+ 98
570
+ 99
571
+ 100
572
+ 101
573
+ 102
574
+ 103</pre>
575
+ </td>
576
+ <td>
577
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 92</span>
578
+
579
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_vcenter'>add_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_fqdn_or_ip'>fqdn_or_ip</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_tenant'>tenant</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>
580
+ <span class='id identifier rubyid_check_vcenter_post'>check_vcenter_post</span><span class='lparen'>(</span><span class='id identifier rubyid_fqdn_or_ip'>fqdn_or_ip</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
581
+ <span class='id identifier rubyid_port'>port</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>443</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_port'>port</span>
582
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
583
+ <span class='label'>ip_address:</span> <span class='id identifier rubyid_fqdn_or_ip'>fqdn_or_ip</span><span class='comma'>,</span>
584
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
585
+ <span class='label'>port_number:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
586
+ <span class='label'>user_name:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span>
587
+ <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span>
588
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
589
+ <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'>/tenants/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@tenant_uid</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vcenters</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>
590
+ <span class='kw'>end</span></pre>
591
+ </td>
592
+ </tr>
593
+ </table>
594
+ </div>
595
+
596
+ <div class="method_details ">
597
+ <h3 class="signature " id="check_vcenter-instance_method">
598
+
599
+ - (<tt>Boolean</tt>) <strong>check_vcenter</strong>(vcenter_id = nil) <span class="extras">(private)</span>
600
+
601
+
602
+
603
+
604
+
605
+ </h3><div class="docstring">
606
+ <div class="discussion">
607
+
608
+ <p>Error Handling method to check for Missing vCenter ID param. If the pass
609
+ fails, an error exception is raised</p>
610
+
611
+
612
+ </div>
613
+ </div>
614
+ <div class="tags">
615
+ <p class="tag_title">Parameters:</p>
616
+ <ul class="param">
617
+
618
+ <li>
619
+
620
+ <span class='name'>vcenter_id</span>
621
+
622
+
623
+ <span class='type'>(<tt>String</tt>)</span>
624
+
625
+
626
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
627
+
628
+
629
+ &mdash;
630
+ <div class='inline'>
631
+ <p>Requires the string of the vcenter uid</p>
632
+ </div>
633
+
634
+ </li>
635
+
636
+ </ul>
637
+
638
+ <p class="tag_title">Returns:</p>
639
+ <ul class="return">
640
+
641
+ <li>
642
+
643
+
644
+ <span class='type'>(<tt>Boolean</tt>)</span>
645
+
646
+
647
+
648
+ &mdash;
649
+ <div class='inline'>
650
+ <p>True if pass, false if it fails</p>
651
+ </div>
652
+
653
+ </li>
654
+
655
+ </ul>
656
+
657
+ </div><table class="source_code">
658
+ <tr>
659
+ <td>
660
+ <pre class="lines">
661
+
662
+
663
+ 129
664
+ 130
665
+ 131
666
+ 132
667
+ 133</pre>
668
+ </td>
669
+ <td>
670
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 129</span>
671
+
672
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_vcenter'>check_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
673
+ <span class='kw'>if</span> <span class='id identifier rubyid_vcenter_id'>vcenter_id</span> <span class='op'>==</span> <span class='kw'>nil</span>
674
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing vCenter ID param (vcenter_id)</span><span class='tstring_end'>&quot;</span></span>
675
+ <span class='kw'>end</span>
676
+ <span class='kw'>end</span></pre>
677
+ </td>
678
+ </tr>
679
+ </table>
680
+ </div>
681
+
682
+ <div class="method_details ">
683
+ <h3 class="signature " id="check_vcenter_object_hash-instance_method">
684
+
685
+ - (<tt>Boolean</tt>) <strong>check_vcenter_object_hash</strong>(vcenter_search_hash = nil) <span class="extras">(private)</span>
686
+
687
+
688
+
689
+
690
+
691
+ </h3><div class="docstring">
692
+ <div class="discussion">
693
+
694
+ <p>Error Handling method to check for Missing vCenter Object param. If the
695
+ pass fails, an error exception is raised</p>
696
+
697
+
698
+ </div>
699
+ </div>
700
+ <div class="tags">
701
+ <p class="tag_title">Parameters:</p>
702
+ <ul class="param">
703
+
704
+ <li>
705
+
706
+ <span class='name'>vcenter_search_hash</span>
707
+
708
+
709
+ <span class='type'>(<tt>String</tt>)</span>
710
+
711
+
712
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
713
+
714
+
715
+ &mdash;
716
+ <div class='inline'>
717
+ <p>Requires the string of something to search</p>
718
+ </div>
719
+
720
+ </li>
721
+
722
+ </ul>
723
+
724
+ <p class="tag_title">Returns:</p>
725
+ <ul class="return">
726
+
727
+ <li>
728
+
729
+
730
+ <span class='type'>(<tt>Boolean</tt>)</span>
731
+
732
+
733
+
734
+ &mdash;
735
+ <div class='inline'>
736
+ <p>True if pass, false if it fails</p>
737
+ </div>
738
+
739
+ </li>
740
+
741
+ </ul>
742
+
743
+ </div><table class="source_code">
744
+ <tr>
745
+ <td>
746
+ <pre class="lines">
747
+
748
+
749
+ 141
750
+ 142
751
+ 143
752
+ 144
753
+ 145</pre>
754
+ </td>
755
+ <td>
756
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 141</span>
757
+
758
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_vcenter_object_hash'>check_vcenter_object_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_search_hash'>vcenter_search_hash</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
759
+ <span class='kw'>if</span> <span class='id identifier rubyid_vcenter_search_hash'>vcenter_search_hash</span> <span class='op'>==</span> <span class='kw'>nil</span>
760
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing vCenter Object to search as a param</span><span class='tstring_end'>&quot;</span></span>
761
+ <span class='kw'>end</span>
762
+ <span class='kw'>end</span></pre>
763
+ </td>
764
+ </tr>
765
+ </table>
766
+ </div>
767
+
768
+ <div class="method_details ">
769
+ <h3 class="signature " id="check_vcenter_post-instance_method">
770
+
771
+ - (<tt>Boolean</tt>) <strong>check_vcenter_post</strong>(fqdn_or_ip = nil, name = nil, user_name = nil, password = nil) <span class="extras">(private)</span>
772
+
773
+
774
+
775
+
776
+
777
+ </h3><div class="docstring">
778
+ <div class="discussion">
779
+
780
+ <p>Error Handling method to check for Missing Param. If the pass fails, an
781
+ error exception is raised</p>
782
+
783
+
784
+ </div>
785
+ </div>
786
+ <div class="tags">
787
+ <p class="tag_title">Parameters:</p>
788
+ <ul class="param">
789
+
790
+ <li>
791
+
792
+ <span class='name'>fqdn_or_ip</span>
793
+
794
+
795
+ <span class='type'>(<tt>String</tt>)</span>
796
+
797
+
798
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
799
+
800
+
801
+ &mdash;
802
+ <div class='inline'>
803
+ <p>Requires the string of the vcenter FQDN or IP Address</p>
804
+ </div>
805
+
806
+ </li>
807
+
808
+ <li>
809
+
810
+ <span class='name'>name</span>
811
+
812
+
813
+ <span class='type'>(<tt>String</tt>)</span>
814
+
815
+
816
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
817
+
818
+
819
+ &mdash;
820
+ <div class='inline'>
821
+ <p>Requires the name of the vCenter</p>
822
+ </div>
823
+
824
+ </li>
825
+
826
+ <li>
827
+
828
+ <span class='name'>user_name</span>
829
+
830
+
831
+ <span class='type'>(<tt>String</tt>)</span>
832
+
833
+
834
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
835
+
836
+
837
+ &mdash;
838
+ <div class='inline'>
839
+ <p>Requires the User Name used for authentication to vCenter</p>
840
+ </div>
841
+
842
+ </li>
843
+
844
+ <li>
845
+
846
+ <span class='name'>password</span>
847
+
848
+
849
+ <span class='type'>(<tt>String</tt>)</span>
850
+
851
+
852
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
853
+
854
+
855
+ &mdash;
856
+ <div class='inline'>
857
+ <p>Requires the password of the User Name used for authentication to vCenter</p>
858
+ </div>
859
+
860
+ </li>
861
+
862
+ </ul>
863
+
864
+ <p class="tag_title">Returns:</p>
865
+ <ul class="return">
866
+
867
+ <li>
868
+
869
+
870
+ <span class='type'>(<tt>Boolean</tt>)</span>
871
+
872
+
873
+
874
+ &mdash;
875
+ <div class='inline'>
876
+ <p>True if pass, false if it fails</p>
877
+ </div>
878
+
879
+ </li>
880
+
881
+ </ul>
882
+
883
+ </div><table class="source_code">
884
+ <tr>
885
+ <td>
886
+ <pre class="lines">
887
+
888
+
889
+ 156
890
+ 157
891
+ 158
892
+ 159
893
+ 160</pre>
894
+ </td>
895
+ <td>
896
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 156</span>
897
+
898
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_vcenter_post'>check_vcenter_post</span><span class='lparen'>(</span><span class='id identifier rubyid_fqdn_or_ip'>fqdn_or_ip</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
899
+ <span class='kw'>if</span> <span class='id identifier rubyid_fqdn_or_ip'>fqdn_or_ip</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id identifier rubyid_user_name'>user_name</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id identifier rubyid_password'>password</span> <span class='op'>==</span> <span class='kw'>nil</span>
900
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing a Required Param of fqdn_or_ip, name, port, user_name, or password</span><span class='tstring_end'>&quot;</span></span>
901
+ <span class='kw'>end</span>
902
+ <span class='kw'>end</span></pre>
903
+ </td>
904
+ </tr>
905
+ </table>
906
+ </div>
907
+
908
+ <div class="method_details ">
909
+ <h3 class="signature " id="delete_vcenter-instance_method">
910
+
911
+ - (<tt>Hash</tt>) <strong>delete_vcenter</strong>(vcenter_id = nil, auth = nil, cert = nil)
912
+
913
+
914
+
915
+
916
+
917
+ </h3><div class="docstring">
918
+ <div class="discussion">
919
+
920
+ <p>Delete a vCenter from any tenant based on vCenter ID</p>
921
+
922
+
923
+ </div>
924
+ </div>
925
+ <div class="tags">
926
+
927
+ <div class="examples">
928
+ <p class="tag_title">Examples:</p>
929
+
930
+
931
+ <pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_vcenters'>get_all_vcenters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
932
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_delete_vcenter'>delete_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
933
+
934
+ </div>
935
+ <p class="tag_title">Parameters:</p>
936
+ <ul class="param">
937
+
938
+ <li>
939
+
940
+ <span class='name'>vcenter_id</span>
941
+
942
+
943
+ <span class='type'>(<tt>String</tt>)</span>
944
+
945
+
946
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
947
+
948
+
949
+ &mdash;
950
+ <div class='inline'>
951
+ <p>Requires the string of the vcenter uid</p>
952
+ </div>
953
+
954
+ </li>
955
+
956
+ </ul>
957
+
958
+ <p class="tag_title">Returns:</p>
959
+ <ul class="return">
960
+
961
+ <li>
962
+
963
+
964
+ <span class='type'>(<tt>Hash</tt>)</span>
965
+
966
+
967
+
968
+ &mdash;
969
+ <div class='inline'>
970
+ <p>The resulted post operation</p>
971
+ </div>
972
+
973
+ </li>
974
+
975
+ </ul>
976
+
977
+ </div><table class="source_code">
978
+ <tr>
979
+ <td>
980
+ <pre class="lines">
981
+
982
+
983
+ 113
984
+ 114
985
+ 115
986
+ 116
987
+ 117
988
+ 118</pre>
989
+ </td>
990
+ <td>
991
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 113</span>
992
+
993
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_vcenter'>delete_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
994
+ <span class='id identifier rubyid_check_vcenter'>check_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='rparen'>)</span>
995
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
996
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
997
+ <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'>/compute/vcenters/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
998
+ <span class='kw'>end</span></pre>
999
+ </td>
1000
+ </tr>
1001
+ </table>
1002
+ </div>
1003
+
1004
+ <div class="method_details ">
1005
+ <h3 class="signature " id="find_vcenter_object-instance_method">
1006
+
1007
+ - (<tt>Hash</tt>) <strong>find_vcenter_object</strong>(vcenter_search_hash = nil, auth = nil, cert = nil)
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+ </h3><div class="docstring">
1014
+ <div class="discussion">
1015
+
1016
+ <p>Search for vCenters matching a specific parameter</p>
1017
+
1018
+
1019
+ </div>
1020
+ </div>
1021
+ <div class="tags">
1022
+
1023
+ <div class="examples">
1024
+ <p class="tag_title">Examples:</p>
1025
+
1026
+
1027
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_find_vcenter_object'>find_vcenter_object</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>demo</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
1028
+
1029
+ </div>
1030
+ <p class="tag_title">Parameters:</p>
1031
+ <ul class="param">
1032
+
1033
+ <li>
1034
+
1035
+ <span class='name'>vcenter_search_hash</span>
1036
+
1037
+
1038
+ <span class='type'>(<tt>String</tt>)</span>
1039
+
1040
+
1041
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1042
+
1043
+
1044
+ &mdash;
1045
+ <div class='inline'>
1046
+ <p>String for searching</p>
1047
+ </div>
1048
+
1049
+ </li>
1050
+
1051
+ </ul>
1052
+
1053
+ <p class="tag_title">Returns:</p>
1054
+ <ul class="return">
1055
+
1056
+ <li>
1057
+
1058
+
1059
+ <span class='type'>(<tt>Hash</tt>)</span>
1060
+
1061
+
1062
+
1063
+ &mdash;
1064
+ <div class='inline'>
1065
+ <p>Will return any vCenter objects containing the search string. The object
1066
+ converted into Hash format and can be parsed with <a href="0">object</a> or
1067
+ <a href="'id'">object</a> notation</p>
1068
+ </div>
1069
+
1070
+ </li>
1071
+
1072
+ </ul>
1073
+
1074
+ </div><table class="source_code">
1075
+ <tr>
1076
+ <td>
1077
+ <pre class="lines">
1078
+
1079
+
1080
+ 73
1081
+ 74
1082
+ 75
1083
+ 76</pre>
1084
+ </td>
1085
+ <td>
1086
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 73</span>
1087
+
1088
+ <span class='kw'>def</span> <span class='id identifier rubyid_find_vcenter_object'>find_vcenter_object</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_search_hash'>vcenter_search_hash</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>
1089
+ <span class='id identifier rubyid_check_vcenter_object_hash'>check_vcenter_object_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_search_hash'>vcenter_search_hash</span><span class='rparen'>)</span>
1090
+ <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'>/compute/vcenters/search?name=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vcenter_search_hash'>vcenter_search_hash</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>
1091
+ <span class='kw'>end</span></pre>
1092
+ </td>
1093
+ </tr>
1094
+ </table>
1095
+ </div>
1096
+
1097
+ <div class="method_details ">
1098
+ <h3 class="signature " id="get_all_vcenters-instance_method">
1099
+
1100
+ - (<tt>Hash</tt>) <strong>get_all_vcenters</strong>(auth = nil, cert = nil)
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+ </h3><div class="docstring">
1107
+ <div class="discussion">
1108
+
1109
+ <p>Retrive all vCenter Servers registered for all tenants</p>
1110
+
1111
+
1112
+ </div>
1113
+ </div>
1114
+ <div class="tags">
1115
+
1116
+ <p class="tag_title">Returns:</p>
1117
+ <ul class="return">
1118
+
1119
+ <li>
1120
+
1121
+
1122
+ <span class='type'>(<tt>Hash</tt>)</span>
1123
+
1124
+
1125
+
1126
+ &mdash;
1127
+ <div class='inline'>
1128
+ <p>the object converted into Hash format and can be parsed with <a
1129
+ href="0">object</a> or <a href="'id'">object</a> notation</p>
1130
+ </div>
1131
+
1132
+ </li>
1133
+
1134
+ </ul>
1135
+
1136
+ </div><table class="source_code">
1137
+ <tr>
1138
+ <td>
1139
+ <pre class="lines">
1140
+
1141
+
1142
+ 10
1143
+ 11
1144
+ 12</pre>
1145
+ </td>
1146
+ <td>
1147
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 10</span>
1148
+
1149
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_all_vcenters'>get_all_vcenters</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>
1150
+ <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'>/compute/vcenters/bulk</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>
1151
+ <span class='kw'>end</span></pre>
1152
+ </td>
1153
+ </tr>
1154
+ </table>
1155
+ </div>
1156
+
1157
+ <div class="method_details ">
1158
+ <h3 class="signature " id="get_vcenter-instance_method">
1159
+
1160
+ - (<tt>Hash</tt>) <strong>get_vcenter</strong>(vcenter_id = nil, auth = nil, cert = nil)
1161
+
1162
+
1163
+
1164
+
1165
+
1166
+ </h3><div class="docstring">
1167
+ <div class="discussion">
1168
+
1169
+ <p>Retrieve information for a single vCenter server using the uid</p>
1170
+
1171
+
1172
+ </div>
1173
+ </div>
1174
+ <div class="tags">
1175
+
1176
+ <div class="examples">
1177
+ <p class="tag_title">Examples:</p>
1178
+
1179
+
1180
+ <pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_vcenters'>get_all_vcenters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
1181
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_vcenter'>get_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
1182
+
1183
+ </div>
1184
+ <p class="tag_title">Parameters:</p>
1185
+ <ul class="param">
1186
+
1187
+ <li>
1188
+
1189
+ <span class='name'>vcenter_id</span>
1190
+
1191
+
1192
+ <span class='type'>(<tt>String</tt>)</span>
1193
+
1194
+
1195
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1196
+
1197
+
1198
+ &mdash;
1199
+ <div class='inline'>
1200
+ <p>Requires the string of the vcenter uid</p>
1201
+ </div>
1202
+
1203
+ </li>
1204
+
1205
+ </ul>
1206
+
1207
+ <p class="tag_title">Returns:</p>
1208
+ <ul class="return">
1209
+
1210
+ <li>
1211
+
1212
+
1213
+ <span class='type'>(<tt>Hash</tt>)</span>
1214
+
1215
+
1216
+
1217
+ &mdash;
1218
+ <div class='inline'>
1219
+ <p>the object converted into Hash format and can be parsed with <a
1220
+ href="0">object</a> or <a href="'id'">object</a> notation</p>
1221
+ </div>
1222
+
1223
+ </li>
1224
+
1225
+ </ul>
1226
+
1227
+ </div><table class="source_code">
1228
+ <tr>
1229
+ <td>
1230
+ <pre class="lines">
1231
+
1232
+
1233
+ 22
1234
+ 23
1235
+ 24
1236
+ 25</pre>
1237
+ </td>
1238
+ <td>
1239
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 22</span>
1240
+
1241
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vcenter'>get_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
1242
+ <span class='id identifier rubyid_check_vcenter'>check_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='rparen'>)</span>
1243
+ <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'>/compute/vcenters/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
1244
+ <span class='kw'>end</span></pre>
1245
+ </td>
1246
+ </tr>
1247
+ </table>
1248
+ </div>
1249
+
1250
+ <div class="method_details ">
1251
+ <h3 class="signature " id="get_vcenter_clusters-instance_method">
1252
+
1253
+ - (<tt>Hash</tt>) <strong>get_vcenter_clusters</strong>(vcenter_id = nil, auth = nil, cert = nil)
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+ </h3><div class="docstring">
1260
+ <div class="discussion">
1261
+
1262
+ <p>Retrieve Cluster information for a single vCenter server using the uid</p>
1263
+
1264
+
1265
+ </div>
1266
+ </div>
1267
+ <div class="tags">
1268
+
1269
+ <div class="examples">
1270
+ <p class="tag_title">Examples:</p>
1271
+
1272
+
1273
+ <pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_vcenters'>get_all_vcenters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
1274
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_vcenter_clusters'>get_vcenter_clusters</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
1275
+
1276
+ </div>
1277
+ <p class="tag_title">Parameters:</p>
1278
+ <ul class="param">
1279
+
1280
+ <li>
1281
+
1282
+ <span class='name'>vcenter_id</span>
1283
+
1284
+
1285
+ <span class='type'>(<tt>String</tt>)</span>
1286
+
1287
+
1288
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1289
+
1290
+
1291
+ &mdash;
1292
+ <div class='inline'>
1293
+ <p>Requires the string of the vcenter uid</p>
1294
+ </div>
1295
+
1296
+ </li>
1297
+
1298
+ </ul>
1299
+
1300
+ <p class="tag_title">Returns:</p>
1301
+ <ul class="return">
1302
+
1303
+ <li>
1304
+
1305
+
1306
+ <span class='type'>(<tt>Hash</tt>)</span>
1307
+
1308
+
1309
+
1310
+ &mdash;
1311
+ <div class='inline'>
1312
+ <p>the object converted into Hash format and can be parsed with <a
1313
+ href="0">object</a> or <a href="'id'">object</a> notation</p>
1314
+ </div>
1315
+
1316
+ </li>
1317
+
1318
+ </ul>
1319
+
1320
+ </div><table class="source_code">
1321
+ <tr>
1322
+ <td>
1323
+ <pre class="lines">
1324
+
1325
+
1326
+ 48
1327
+ 49
1328
+ 50
1329
+ 51</pre>
1330
+ </td>
1331
+ <td>
1332
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 48</span>
1333
+
1334
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vcenter_clusters'>get_vcenter_clusters</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
1335
+ <span class='id identifier rubyid_check_vcenter'>check_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='rparen'>)</span>
1336
+ <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'>/compute/vcenters/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/clusters</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>
1337
+ <span class='kw'>end</span></pre>
1338
+ </td>
1339
+ </tr>
1340
+ </table>
1341
+ </div>
1342
+
1343
+ <div class="method_details ">
1344
+ <h3 class="signature " id="get_vcenter_datacenters-instance_method">
1345
+
1346
+ - (<tt>Hash</tt>) <strong>get_vcenter_datacenters</strong>(vcenter_id = nil, auth = nil, cert = nil)
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+ </h3><div class="docstring">
1353
+ <div class="discussion">
1354
+
1355
+ <p>Retrieve Datacenter information for a single vCenter server using the uid</p>
1356
+
1357
+
1358
+ </div>
1359
+ </div>
1360
+ <div class="tags">
1361
+
1362
+ <div class="examples">
1363
+ <p class="tag_title">Examples:</p>
1364
+
1365
+
1366
+ <pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_vcenters'>get_all_vcenters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
1367
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_vcenter_datacenters'>get_vcenter_datacenters</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
1368
+
1369
+ </div>
1370
+ <p class="tag_title">Parameters:</p>
1371
+ <ul class="param">
1372
+
1373
+ <li>
1374
+
1375
+ <span class='name'>vcenter_id</span>
1376
+
1377
+
1378
+ <span class='type'>(<tt>String</tt>)</span>
1379
+
1380
+
1381
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1382
+
1383
+
1384
+ &mdash;
1385
+ <div class='inline'>
1386
+ <p>Requires the string of the vcenter uid</p>
1387
+ </div>
1388
+
1389
+ </li>
1390
+
1391
+ </ul>
1392
+
1393
+ <p class="tag_title">Returns:</p>
1394
+ <ul class="return">
1395
+
1396
+ <li>
1397
+
1398
+
1399
+ <span class='type'>(<tt>Hash</tt>)</span>
1400
+
1401
+
1402
+
1403
+ &mdash;
1404
+ <div class='inline'>
1405
+ <p>the object converted into Hash format and can be parsed with <a
1406
+ href="0">object</a> or <a href="'id'">object</a> notation</p>
1407
+ </div>
1408
+
1409
+ </li>
1410
+
1411
+ </ul>
1412
+
1413
+ </div><table class="source_code">
1414
+ <tr>
1415
+ <td>
1416
+ <pre class="lines">
1417
+
1418
+
1419
+ 61
1420
+ 62
1421
+ 63
1422
+ 64</pre>
1423
+ </td>
1424
+ <td>
1425
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 61</span>
1426
+
1427
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vcenter_datacenters'>get_vcenter_datacenters</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
1428
+ <span class='id identifier rubyid_check_vcenter'>check_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='rparen'>)</span>
1429
+ <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'>/compute/vcenters/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vcenter-data-centers</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>
1430
+ <span class='kw'>end</span></pre>
1431
+ </td>
1432
+ </tr>
1433
+ </table>
1434
+ </div>
1435
+
1436
+ <div class="method_details ">
1437
+ <h3 class="signature " id="get_vcenter_hosts-instance_method">
1438
+
1439
+ - (<tt>Hash</tt>) <strong>get_vcenter_hosts</strong>(vcenter_id = nil, auth = nil, cert = nil)
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+ </h3><div class="docstring">
1446
+ <div class="discussion">
1447
+
1448
+ <p>Retrieve Host information for a single vCenter server using the uid</p>
1449
+
1450
+
1451
+ </div>
1452
+ </div>
1453
+ <div class="tags">
1454
+
1455
+ <div class="examples">
1456
+ <p class="tag_title">Examples:</p>
1457
+
1458
+
1459
+ <pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_vcenters'>get_all_vcenters</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
1460
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_vcenter_hosts'>get_vcenter_hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
1461
+
1462
+ </div>
1463
+ <p class="tag_title">Parameters:</p>
1464
+ <ul class="param">
1465
+
1466
+ <li>
1467
+
1468
+ <span class='name'>vcenter_id</span>
1469
+
1470
+
1471
+ <span class='type'>(<tt>String</tt>)</span>
1472
+
1473
+
1474
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1475
+
1476
+
1477
+ &mdash;
1478
+ <div class='inline'>
1479
+ <p>Requires the string of the vcenter uid</p>
1480
+ </div>
1481
+
1482
+ </li>
1483
+
1484
+ </ul>
1485
+
1486
+ <p class="tag_title">Returns:</p>
1487
+ <ul class="return">
1488
+
1489
+ <li>
1490
+
1491
+
1492
+ <span class='type'>(<tt>Hash</tt>)</span>
1493
+
1494
+
1495
+
1496
+ &mdash;
1497
+ <div class='inline'>
1498
+ <p>the object converted into Hash format and can be parsed with <a
1499
+ href="0">object</a> or <a href="'id'">object</a> notation</p>
1500
+ </div>
1501
+
1502
+ </li>
1503
+
1504
+ </ul>
1505
+
1506
+ </div><table class="source_code">
1507
+ <tr>
1508
+ <td>
1509
+ <pre class="lines">
1510
+
1511
+
1512
+ 35
1513
+ 36
1514
+ 37
1515
+ 38</pre>
1516
+ </td>
1517
+ <td>
1518
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/vcenter.rb', line 35</span>
1519
+
1520
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_vcenter_hosts'>get_vcenter_hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_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>
1521
+ <span class='id identifier rubyid_check_vcenter'>check_vcenter</span><span class='lparen'>(</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='rparen'>)</span>
1522
+ <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'>/compute/vcenters/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_vcenter_id'>vcenter_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/hosts</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>
1523
+ <span class='kw'>end</span></pre>
1524
+ </td>
1525
+ </tr>
1526
+ </table>
1527
+ </div>
1528
+
1529
+ </div>
1530
+
1531
+ </div>
1532
+
1533
+ <div id="footer">
1534
+ Generated on Mon Dec 15 13:52:44 2014 by
1535
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1536
+ 0.8.7.6 (ruby-2.1.2).
1537
+ </div>
1538
+
1539
+ </body>
1540
+ </html>