vipruby 0.1.4 → 0.1.6.1

Sign up to get free protection for your applications and to get access to all the features.
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/ViprStorageSystem.html ADDED
@@ -0,0 +1,2695 @@
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: ViprStorageSystem
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#!ViprStorageSystem.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">ViprStorageSystem</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: ViprStorageSystem
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/storagesystem.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 Storage System calls will add Storage Systems for all
95
+ tenants. these commands can only be ran as the root/default tenant</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="#add_emc_block-instance_method" title="#add_emc_block (instance method)">- (Hash) <strong>add_emc_block</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = 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>Add EMC VMAX and VNX Block Storage System.</p>
137
+ </div></span>
138
+
139
+ </li>
140
+
141
+
142
+ <li class="public ">
143
+ <span class="summary_signature">
144
+
145
+ <a href="#add_emc_file-instance_method" title="#add_emc_file (instance method)">- (Hash) <strong>add_emc_file</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, smis_provider_ip = nil, smis_user_name = nil, smis_password = nil, smis_port_number = nil, smis_use_ssl = nil, auth = nil, cert = nil) </a>
146
+
147
+
148
+
149
+ </span>
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'>
160
+ <p>Add EMC VNX for File Storage Provider.</p>
161
+ </div></span>
162
+
163
+ </li>
164
+
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#add_hitachi-instance_method" title="#add_hitachi (instance method)">- (Hash) <strong>add_hitachi</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, 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>Add Hitachi Storage Systems.</p>
185
+ </div></span>
186
+
187
+ </li>
188
+
189
+
190
+ <li class="public ">
191
+ <span class="summary_signature">
192
+
193
+ <a href="#add_isilon-instance_method" title="#add_isilon (instance method)">- (Hash) <strong>add_isilon</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, 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>Add Isilon Storage Provider.</p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#add_netapp-instance_method" title="#add_netapp (instance method)">- (Hash) <strong>add_netapp</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, 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>Add NetApp Storage Provider.</p>
233
+ </div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#add_scaleio-instance_method" title="#add_scaleio (instance method)">- (Hash) <strong>add_scaleio</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, 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>Add ScaleIO Storage Systems.</p>
257
+ </div></span>
258
+
259
+ </li>
260
+
261
+
262
+ <li class="public ">
263
+ <span class="summary_signature">
264
+
265
+ <a href="#add_third_party_block-instance_method" title="#add_third_party_block (instance method)">- (Hash) <strong>add_third_party_block</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, 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>Add Third Party Block Storage Provider.</p>
281
+ </div></span>
282
+
283
+ </li>
284
+
285
+
286
+ <li class="public ">
287
+ <span class="summary_signature">
288
+
289
+ <a href="#add_vplex-instance_method" title="#add_vplex (instance method)">- (Hash) <strong>add_vplex</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, auth = nil, cert = nil) </a>
290
+
291
+
292
+
293
+ </span>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+ <span class="summary_desc"><div class='inline'>
304
+ <p>Add VPLEX Storage Systems.</p>
305
+ </div></span>
306
+
307
+ </li>
308
+
309
+
310
+ <li class="private ">
311
+ <span class="summary_signature">
312
+
313
+ <a href="#check_storage_provider_payload-instance_method" title="#check_storage_provider_payload (instance method)">- (Boolean) <strong>check_storage_provider_payload</strong>(name = nil, ip_or_dns = nil) </a>
314
+
315
+
316
+
317
+ </span>
318
+
319
+
320
+
321
+ <span class="note title private">private</span>
322
+
323
+
324
+
325
+
326
+
327
+ <span class="summary_desc"><div class='inline'>
328
+ <p>Error Handling method to check for Missing Param.</p>
329
+ </div></span>
330
+
331
+ </li>
332
+
333
+
334
+ <li class="public ">
335
+ <span class="summary_signature">
336
+
337
+ <a href="#storage_provider_payload-instance_method" title="#storage_provider_payload (instance method)">- (JSON) <strong>storage_provider_payload</strong>(name, interface_type, ip_or_dns, port, user_name, password, use_ssl) </a>
338
+
339
+
340
+
341
+ </span>
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+ <span class="summary_desc"><div class='inline'>
352
+ <p>The JSON structure for the post operation.</p>
353
+ </div></span>
354
+
355
+ </li>
356
+
357
+
358
+ <li class="public ">
359
+ <span class="summary_signature">
360
+
361
+ <a href="#storage_system_payload-instance_method" title="#storage_system_payload (instance method)">- (JSON) <strong>storage_system_payload</strong>(name, system_type, ip_or_dns, port, user_name, password, smis_provider_ip = nil, smis_port_number = nil, smis_user_name = nil, smis_password = nil, smis_use_ssl = nil) </a>
362
+
363
+
364
+
365
+ </span>
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+ <span class="summary_desc"><div class='inline'>
376
+ <p>The JSON structure for the post operation.</p>
377
+ </div></span>
378
+
379
+ </li>
380
+
381
+
382
+ </ul>
383
+
384
+
385
+
386
+
387
+ <div id="instance_method_details" class="method_details_list">
388
+ <h2>Instance Method Details</h2>
389
+
390
+
391
+ <div class="method_details first">
392
+ <h3 class="signature first" id="add_emc_block-instance_method">
393
+
394
+ - (<tt>Hash</tt>) <strong>add_emc_block</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, auth = nil, cert = nil)
395
+
396
+
397
+
398
+
399
+
400
+ </h3><div class="docstring">
401
+ <div class="discussion">
402
+
403
+ <div class="note notetag">
404
+ <strong>Note:</strong>
405
+ <div class='inline'>
406
+ <p>For supported versions, see the EMC ViPR Support Matrix on the EMC
407
+ Community Network (community.emc.com)</p>
408
+ </div>
409
+ </div>
410
+
411
+
412
+ <p>Add EMC VMAX and VNX Block Storage System</p>
413
+
414
+
415
+ </div>
416
+ </div>
417
+ <div class="tags">
418
+
419
+ <div class="examples">
420
+ <p class="tag_title">Examples:</p>
421
+
422
+
423
+ <p class="example_title"><div class='inline'>
424
+ <p>Add EMC VMAX and VNX Block Storage System</p>
425
+ </div></p>
426
+
427
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_emc_block'>add_emc_block</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vnx01</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'>vnx01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
428
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_emc_block'>add_emc_block</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vnx02</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'>vnx02.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
429
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_emc_block'>add_emc_block</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vnx03</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'>vnx03.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'>sysadmin</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'>sysadmin</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'>8093</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'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
430
+
431
+ </div>
432
+ <p class="tag_title">Parameters:</p>
433
+ <ul class="param">
434
+
435
+ <li>
436
+
437
+ <span class='name'>name</span>
438
+
439
+
440
+ <span class='type'>(<tt>String</tt>)</span>
441
+
442
+
443
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
444
+
445
+
446
+ &mdash;
447
+ <div class='inline'>
448
+ <p>Name of the EMC Block Device. This name is arbitrary and only exists within
449
+ ViPR. This is a required string.</p>
450
+ </div>
451
+
452
+ </li>
453
+
454
+ <li>
455
+
456
+ <span class='name'>ip_or_dns</span>
457
+
458
+
459
+ <span class='type'>(<tt>String</tt>)</span>
460
+
461
+
462
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
463
+
464
+
465
+ &mdash;
466
+ <div class='inline'>
467
+ <p>FQDN or IP Address of the EMC Block Device to add. This is a required
468
+ string.</p>
469
+ </div>
470
+
471
+ </li>
472
+
473
+ <li>
474
+
475
+ <span class='name'>user_name</span>
476
+
477
+
478
+ <span class='type'>(<tt>String</tt>)</span>
479
+
480
+
481
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
482
+
483
+
484
+ &mdash;
485
+ <div class='inline'>
486
+ <p>User Name that will be used for authenticating against the EMC Block
487
+ Device. This is an optional string. If no parameter is passed, then
488
+ &#39;admin&#39; is used. If you wish to specify a different password, port,
489
+ or use_ssl param set this to nil</p>
490
+ </div>
491
+
492
+ </li>
493
+
494
+ <li>
495
+
496
+ <span class='name'>password</span>
497
+
498
+
499
+ <span class='type'>(<tt>String</tt>)</span>
500
+
501
+
502
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
503
+
504
+
505
+ &mdash;
506
+ <div class='inline'>
507
+ <p>Password that will be used for authenticating against the EMC Block Device.
508
+ This is an optional string. If no parameter is passed, then
509
+ &#39;#1Password&#39; is used. If you wish to specify a different username,
510
+ port, or use_ssl param set this to nil</p>
511
+ </div>
512
+
513
+ </li>
514
+
515
+ <li>
516
+
517
+ <span class='name'>port</span>
518
+
519
+
520
+ <span class='type'>(<tt>String</tt>)</span>
521
+
522
+
523
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
524
+
525
+
526
+ &mdash;
527
+ <div class='inline'>
528
+ <p>Port that will be used for communicating with the EMC Block Device. This is
529
+ an optional string. If no parameter is passed, then &#39;5989&#39; is used.
530
+ If you wish to specify a different user_name, password, or use_ssl param
531
+ set this to nil</p>
532
+ </div>
533
+
534
+ </li>
535
+
536
+ <li>
537
+
538
+ <span class='name'>use_ssl</span>
539
+
540
+
541
+ <span class='type'>(<tt>String</tt>)</span>
542
+
543
+
544
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
545
+
546
+
547
+ &mdash;
548
+ <div class='inline'>
549
+ <p>SSL setting for communicating with the EMC Block Device. This is an
550
+ optional string. If no parameter is passed, then &#39;false&#39; is used.</p>
551
+ </div>
552
+
553
+ </li>
554
+
555
+ </ul>
556
+
557
+ <p class="tag_title">Returns:</p>
558
+ <ul class="return">
559
+
560
+ <li>
561
+
562
+
563
+ <span class='type'>(<tt>Hash</tt>)</span>
564
+
565
+
566
+
567
+ &mdash;
568
+ <div class='inline'>
569
+ <p>The resulted post operation</p>
570
+ </div>
571
+
572
+ </li>
573
+
574
+ </ul>
575
+
576
+ </div><table class="source_code">
577
+ <tr>
578
+ <td>
579
+ <pre class="lines">
580
+
581
+
582
+ 91
583
+ 92
584
+ 93
585
+ 94
586
+ 95</pre>
587
+ </td>
588
+ <td>
589
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 91</span>
590
+
591
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_emc_block'>add_emc_block</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_use_ssl'>use_ssl</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>
592
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
593
+ <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'>5989</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>
594
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_provider_payload'>storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>smis</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='rparen'>)</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-providers</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>
595
+ <span class='kw'>end</span></pre>
596
+ </td>
597
+ </tr>
598
+ </table>
599
+ </div>
600
+
601
+ <div class="method_details ">
602
+ <h3 class="signature " id="add_emc_file-instance_method">
603
+
604
+ - (<tt>Hash</tt>) <strong>add_emc_file</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, smis_provider_ip = nil, smis_user_name = nil, smis_password = nil, smis_port_number = nil, smis_use_ssl = nil, auth = nil, cert = nil)
605
+
606
+
607
+
608
+
609
+
610
+ </h3><div class="docstring">
611
+ <div class="discussion">
612
+
613
+ <div class="note notetag">
614
+ <strong>Note:</strong>
615
+ <div class='inline'>
616
+ <p>VNX File Control Station default port is 443. VNX File Onboard Storage
617
+ Provider default port is 5988</p>
618
+ </div>
619
+ </div>
620
+
621
+
622
+ <p>Add EMC VNX for File Storage Provider</p>
623
+
624
+
625
+ </div>
626
+ </div>
627
+ <div class="tags">
628
+
629
+ <div class="examples">
630
+ <p class="tag_title">Examples:</p>
631
+
632
+
633
+ <p class="example_title"><div class='inline'>
634
+ <p>Add EMC VNX for File Storage Provider</p>
635
+ </div></p>
636
+
637
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_emc_file'>add_emc_file</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vnx01</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'>vnx01.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'>sysadmin</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'>sysadmin</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'>smi_s_ip</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'>smi_s_un</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'>smi_s_pw</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
638
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_emc_file'>add_emc_file</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vnx01</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'>vnx01.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'>sysadmin</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'>sysadmin</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'>1067</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'>smi_s_ip</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'>smi_s_un</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'>smi_s_pw</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'>1068</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'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
639
+
640
+ </div>
641
+ <p class="tag_title">Parameters:</p>
642
+ <ul class="param">
643
+
644
+ <li>
645
+
646
+ <span class='name'>name</span>
647
+
648
+
649
+ <span class='type'>(<tt>String</tt>)</span>
650
+
651
+
652
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
653
+
654
+
655
+ &mdash;
656
+ <div class='inline'>
657
+ <p>Name of the EMC VNX for File Storage Provider. This name is arbitrary and
658
+ only exists within ViPR. This is a required string.</p>
659
+ </div>
660
+
661
+ </li>
662
+
663
+ <li>
664
+
665
+ <span class='name'>ip_or_dns</span>
666
+
667
+
668
+ <span class='type'>(<tt>String</tt>)</span>
669
+
670
+
671
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
672
+
673
+
674
+ &mdash;
675
+ <div class='inline'>
676
+ <p>FQDN or IP Address of the EMC VNX for File Storage Provider to add. This is
677
+ a required string.</p>
678
+ </div>
679
+
680
+ </li>
681
+
682
+ <li>
683
+
684
+ <span class='name'>user_name</span>
685
+
686
+
687
+ <span class='type'>(<tt>String</tt>)</span>
688
+
689
+
690
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
691
+
692
+
693
+ &mdash;
694
+ <div class='inline'>
695
+ <p>User Name that will be used for authenticating against the EMC VNX for File
696
+ Storage Provider. This is an optional string. If no parameter is passed,
697
+ then &#39;admin&#39; is used. If you wish to specify a different password,
698
+ port, or use_ssl param set this to nil</p>
699
+ </div>
700
+
701
+ </li>
702
+
703
+ <li>
704
+
705
+ <span class='name'>password</span>
706
+
707
+
708
+ <span class='type'>(<tt>String</tt>)</span>
709
+
710
+
711
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
712
+
713
+
714
+ &mdash;
715
+ <div class='inline'>
716
+ <p>Password that will be used for authenticating against the EMC VNX for File
717
+ Storage Provider. This is an optional string. If no parameter is passed,
718
+ then &#39;#1Password&#39; is used. If you wish to specify a different
719
+ username, port, or use_ssl param set this to nil</p>
720
+ </div>
721
+
722
+ </li>
723
+
724
+ <li>
725
+
726
+ <span class='name'>port</span>
727
+
728
+
729
+ <span class='type'>(<tt>String</tt>)</span>
730
+
731
+
732
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
733
+
734
+
735
+ &mdash;
736
+ <div class='inline'>
737
+ <p>Port that will be used for communicating with the EMC VNX for File Storage
738
+ Provider. This is an optional string. If no parameter is passed, then
739
+ &#39;443&#39; is used. If you wish to specify a different user_name,
740
+ password, or use_ssl param set this to nil</p>
741
+ </div>
742
+
743
+ </li>
744
+
745
+ <li>
746
+
747
+ <span class='name'>smis_provider_ip</span>
748
+
749
+
750
+ <span class='type'>(<tt>String</tt>)</span>
751
+
752
+
753
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
754
+
755
+
756
+ &mdash;
757
+ <div class='inline'>
758
+ <p>IP Address for the SMI-S Communicator for the EMC VNX for File Storage
759
+ Provider. This is a required string.</p>
760
+ </div>
761
+
762
+ </li>
763
+
764
+ <li>
765
+
766
+ <span class='name'>smis_user_name</span>
767
+
768
+
769
+ <span class='type'>(<tt>String</tt>)</span>
770
+
771
+
772
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
773
+
774
+
775
+ &mdash;
776
+ <div class='inline'>
777
+ <p>User Name for the SMI-S Communicator for the EMC VNX for File Storage
778
+ Provider. This is an optional string. If no parameter is passed, then
779
+ &#39;admin&#39; is used.</p>
780
+ </div>
781
+
782
+ </li>
783
+
784
+ <li>
785
+
786
+ <span class='name'>smis_password</span>
787
+
788
+
789
+ <span class='type'>(<tt>String</tt>)</span>
790
+
791
+
792
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
793
+
794
+
795
+ &mdash;
796
+ <div class='inline'>
797
+ <p>Password for the user_name for the SMI-S Communicator for the EMC VNX for
798
+ File Storage Provider. This is an optional string. If no parameter is
799
+ passed, then &#39;#1Password&#39; is used.</p>
800
+ </div>
801
+
802
+ </li>
803
+
804
+ <li>
805
+
806
+ <span class='name'>smis_port_number</span>
807
+
808
+
809
+ <span class='type'>(<tt>String</tt>)</span>
810
+
811
+
812
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
813
+
814
+
815
+ &mdash;
816
+ <div class='inline'>
817
+ <p>Port Number for the SMI-S Communicator for the EMC VNX for File Storage
818
+ Provider. This is an optional string. If no parameter is passed, then
819
+ &#39;5988&#39; is used.</p>
820
+ </div>
821
+
822
+ </li>
823
+
824
+ <li>
825
+
826
+ <span class='name'>smis_use_ssl</span>
827
+
828
+
829
+ <span class='type'>(<tt>String</tt>)</span>
830
+
831
+
832
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
833
+
834
+
835
+ &mdash;
836
+ <div class='inline'>
837
+ <p>SSL setting for communicating with the SMI-S Communicator for the EMC VNX
838
+ for File Storage Provider. This is an optional string. If no parameter is
839
+ passed, then &#39;false&#39; is used.</p>
840
+ </div>
841
+
842
+ </li>
843
+
844
+ </ul>
845
+
846
+ <p class="tag_title">Returns:</p>
847
+ <ul class="return">
848
+
849
+ <li>
850
+
851
+
852
+ <span class='type'>(<tt>Hash</tt>)</span>
853
+
854
+
855
+
856
+ &mdash;
857
+ <div class='inline'>
858
+ <p>The resulted post operation</p>
859
+ </div>
860
+
861
+ </li>
862
+
863
+ </ul>
864
+
865
+ </div><table class="source_code">
866
+ <tr>
867
+ <td>
868
+ <pre class="lines">
869
+
870
+
871
+ 234
872
+ 235
873
+ 236
874
+ 237
875
+ 238
876
+ 239</pre>
877
+ </td>
878
+ <td>
879
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 234</span>
880
+
881
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_emc_file'>add_emc_file</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_smis_provider_ip'>smis_provider_ip</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_user_name'>smis_user_name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_password'>smis_password</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_use_ssl'>smis_use_ssl</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>
882
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
883
+ <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>
884
+ <span class='id identifier rubyid_smis_port_number'>smis_port_number</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>5988</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span> <span class='op'>=</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span>
885
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_system_payload'>storage_system_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vnxfile</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_smis_provider_ip'>smis_provider_ip</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_user_name'>smis_user_name</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_password'>smis_password</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_use_ssl'>smis_use_ssl</span><span class='rparen'>)</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-systems</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>
886
+ <span class='kw'>end</span></pre>
887
+ </td>
888
+ </tr>
889
+ </table>
890
+ </div>
891
+
892
+ <div class="method_details ">
893
+ <h3 class="signature " id="add_hitachi-instance_method">
894
+
895
+ - (<tt>Hash</tt>) <strong>add_hitachi</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, auth = nil, cert = nil)
896
+
897
+
898
+
899
+
900
+
901
+ </h3><div class="docstring">
902
+ <div class="discussion">
903
+
904
+ <div class="note notetag">
905
+ <strong>Note:</strong>
906
+ <div class='inline'>
907
+ <p>For supported versions, see the EMC ViPR Support Matrix on the EMC
908
+ Community Network (community.emc.com). Hitachi HiCommand Device Manager is
909
+ required to use HDS storage with ViPR. You need to obtain the following
910
+ information to configure and add the Hitachi HiCommand Device manager to
911
+ ViPR: (1) A host or virtual machine for HiCommand Device manager setup (2)
912
+ HiCommand Device Manager license, host address, credentials, and host port
913
+ (default is 2001)</p>
914
+ </div>
915
+ </div>
916
+
917
+
918
+ <p>Add Hitachi Storage Systems</p>
919
+
920
+
921
+ </div>
922
+ </div>
923
+ <div class="tags">
924
+
925
+ <div class="examples">
926
+ <p class="tag_title">Examples:</p>
927
+
928
+
929
+ <p class="example_title"><div class='inline'>
930
+ <p>Add Hitachi Storage System</p>
931
+ </div></p>
932
+
933
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_hitachi'>add_hitachi</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hitachi01</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'>hitachi01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
934
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_hitachi'>add_hitachi</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hitachi02</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'>hitachi02.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
935
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_hitachi'>add_hitachi</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hitachi03</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'>hitachi03.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'>sysadmin</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'>sysadmin</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'>8093</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'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
936
+
937
+ </div>
938
+ <p class="tag_title">Parameters:</p>
939
+ <ul class="param">
940
+
941
+ <li>
942
+
943
+ <span class='name'>name</span>
944
+
945
+
946
+ <span class='type'>(<tt>String</tt>)</span>
947
+
948
+
949
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
950
+
951
+
952
+ &mdash;
953
+ <div class='inline'>
954
+ <p>Name of the Hitachi Device. This name is arbitrary and only exists within
955
+ ViPR. This is a required string.</p>
956
+ </div>
957
+
958
+ </li>
959
+
960
+ <li>
961
+
962
+ <span class='name'>ip_or_dns</span>
963
+
964
+
965
+ <span class='type'>(<tt>String</tt>)</span>
966
+
967
+
968
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
969
+
970
+
971
+ &mdash;
972
+ <div class='inline'>
973
+ <p>FQDN or IP Address of the Hitachi Device to add. This is a required string.</p>
974
+ </div>
975
+
976
+ </li>
977
+
978
+ <li>
979
+
980
+ <span class='name'>user_name</span>
981
+
982
+
983
+ <span class='type'>(<tt>String</tt>)</span>
984
+
985
+
986
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
987
+
988
+
989
+ &mdash;
990
+ <div class='inline'>
991
+ <p>User Name that will be used for authenticating against the Hitachi Device.
992
+ This is an optional string. If no parameter is passed, then &#39;admin&#39;
993
+ is used. If you wish to specify a different password, port, or use_ssl
994
+ param set this to nil</p>
995
+ </div>
996
+
997
+ </li>
998
+
999
+ <li>
1000
+
1001
+ <span class='name'>password</span>
1002
+
1003
+
1004
+ <span class='type'>(<tt>String</tt>)</span>
1005
+
1006
+
1007
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1008
+
1009
+
1010
+ &mdash;
1011
+ <div class='inline'>
1012
+ <p>Password that will be used for authenticating against the Hitachi Device.
1013
+ This is an optional string. If no parameter is passed, then
1014
+ &#39;#1Password&#39; is used. If you wish to specify a different username,
1015
+ port, or use_ssl param set this to nil</p>
1016
+ </div>
1017
+
1018
+ </li>
1019
+
1020
+ <li>
1021
+
1022
+ <span class='name'>port</span>
1023
+
1024
+
1025
+ <span class='type'>(<tt>String</tt>)</span>
1026
+
1027
+
1028
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1029
+
1030
+
1031
+ &mdash;
1032
+ <div class='inline'>
1033
+ <p>Port that will be used for communicating with the Hitachi Device. This is
1034
+ an optional string. If no parameter is passed, then &#39;2001&#39; is used.
1035
+ If you wish to specify a different user_name, password, or use_ssl param
1036
+ set this to nil</p>
1037
+ </div>
1038
+
1039
+ </li>
1040
+
1041
+ <li>
1042
+
1043
+ <span class='name'>use_ssl</span>
1044
+
1045
+
1046
+ <span class='type'>(<tt>String</tt>)</span>
1047
+
1048
+
1049
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1050
+
1051
+
1052
+ &mdash;
1053
+ <div class='inline'>
1054
+ <p>SSL setting for communicating with the Hitachi Device. This is an optional
1055
+ string. If no parameter is passed, then &#39;false&#39; is used.</p>
1056
+ </div>
1057
+
1058
+ </li>
1059
+
1060
+ </ul>
1061
+
1062
+ <p class="tag_title">Returns:</p>
1063
+ <ul class="return">
1064
+
1065
+ <li>
1066
+
1067
+
1068
+ <span class='type'>(<tt>Hash</tt>)</span>
1069
+
1070
+
1071
+
1072
+ &mdash;
1073
+ <div class='inline'>
1074
+ <p>The resulted post operation</p>
1075
+ </div>
1076
+
1077
+ </li>
1078
+
1079
+ </ul>
1080
+
1081
+ </div><table class="source_code">
1082
+ <tr>
1083
+ <td>
1084
+ <pre class="lines">
1085
+
1086
+
1087
+ 117
1088
+ 118
1089
+ 119
1090
+ 120
1091
+ 121</pre>
1092
+ </td>
1093
+ <td>
1094
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 117</span>
1095
+
1096
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_hitachi'>add_hitachi</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_use_ssl'>use_ssl</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>
1097
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
1098
+ <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'>2001</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>
1099
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_provider_payload'>storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hicommand</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='rparen'>)</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-providers</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>
1100
+ <span class='kw'>end</span></pre>
1101
+ </td>
1102
+ </tr>
1103
+ </table>
1104
+ </div>
1105
+
1106
+ <div class="method_details ">
1107
+ <h3 class="signature " id="add_isilon-instance_method">
1108
+
1109
+ - (<tt>Hash</tt>) <strong>add_isilon</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, auth = nil, cert = nil)
1110
+
1111
+
1112
+
1113
+
1114
+
1115
+ </h3><div class="docstring">
1116
+ <div class="discussion">
1117
+
1118
+ <div class="note notetag">
1119
+ <strong>Note:</strong>
1120
+ <div class='inline'>
1121
+ <p>Supported Protocol: NFS, CIFS (Snapshot restore is not supported for Isilon
1122
+ storage systems.). Port (default is 8080)</p>
1123
+ </div>
1124
+ </div>
1125
+
1126
+
1127
+ <p>Add Isilon Storage Provider</p>
1128
+
1129
+
1130
+ </div>
1131
+ </div>
1132
+ <div class="tags">
1133
+
1134
+ <div class="examples">
1135
+ <p class="tag_title">Examples:</p>
1136
+
1137
+
1138
+ <p class="example_title"><div class='inline'>
1139
+ <p>Add Isilon Storage Provider</p>
1140
+ </div></p>
1141
+
1142
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_isilon'>add_isilon</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isilon01</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'>isilon01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1143
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_isilon'>add_isilon</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isilon01</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'>isilon01.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1144
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_isilon'>add_isilon</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isilon01</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'>isilon01.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'>sysadmin</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'>sysadmin</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'>8093</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
1145
+
1146
+ </div>
1147
+ <p class="tag_title">Parameters:</p>
1148
+ <ul class="param">
1149
+
1150
+ <li>
1151
+
1152
+ <span class='name'>name</span>
1153
+
1154
+
1155
+ <span class='type'>(<tt>String</tt>)</span>
1156
+
1157
+
1158
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1159
+
1160
+
1161
+ &mdash;
1162
+ <div class='inline'>
1163
+ <p>Name of the Isilon Storage Provider. This name is arbitrary and only exists
1164
+ within ViPR. This is a required string.</p>
1165
+ </div>
1166
+
1167
+ </li>
1168
+
1169
+ <li>
1170
+
1171
+ <span class='name'>ip_or_dns</span>
1172
+
1173
+
1174
+ <span class='type'>(<tt>String</tt>)</span>
1175
+
1176
+
1177
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1178
+
1179
+
1180
+ &mdash;
1181
+ <div class='inline'>
1182
+ <p>FQDN or IP Address of the Isilon Storage Provider to add. This is a
1183
+ required string.</p>
1184
+ </div>
1185
+
1186
+ </li>
1187
+
1188
+ <li>
1189
+
1190
+ <span class='name'>user_name</span>
1191
+
1192
+
1193
+ <span class='type'>(<tt>String</tt>)</span>
1194
+
1195
+
1196
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1197
+
1198
+
1199
+ &mdash;
1200
+ <div class='inline'>
1201
+ <p>User Name that will be used for authenticating against the Isilon Storage
1202
+ Provider. This is an optional string. If no parameter is passed, then
1203
+ &#39;admin&#39; is used. If you wish to specify a different password, port,
1204
+ or use_ssl param set this to nil</p>
1205
+ </div>
1206
+
1207
+ </li>
1208
+
1209
+ <li>
1210
+
1211
+ <span class='name'>password</span>
1212
+
1213
+
1214
+ <span class='type'>(<tt>String</tt>)</span>
1215
+
1216
+
1217
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1218
+
1219
+
1220
+ &mdash;
1221
+ <div class='inline'>
1222
+ <p>Password that will be used for authenticating against the Isilon Storage
1223
+ Provider. This is an optional string. If no parameter is passed, then
1224
+ &#39;#1Password&#39; is used. If you wish to specify a different username,
1225
+ port, or use_ssl param set this to nil</p>
1226
+ </div>
1227
+
1228
+ </li>
1229
+
1230
+ <li>
1231
+
1232
+ <span class='name'>port</span>
1233
+
1234
+
1235
+ <span class='type'>(<tt>String</tt>)</span>
1236
+
1237
+
1238
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1239
+
1240
+
1241
+ &mdash;
1242
+ <div class='inline'>
1243
+ <p>Port that will be used for communicating with the Isilon Storage Provider.
1244
+ This is an optional string. If no parameter is passed, then &#39;8080&#39;
1245
+ is used. If you wish to specify a different user_name, password, or use_ssl
1246
+ param set this to nil</p>
1247
+ </div>
1248
+
1249
+ </li>
1250
+
1251
+ </ul>
1252
+
1253
+ <p class="tag_title">Returns:</p>
1254
+ <ul class="return">
1255
+
1256
+ <li>
1257
+
1258
+
1259
+ <span class='type'>(<tt>Hash</tt>)</span>
1260
+
1261
+
1262
+
1263
+ &mdash;
1264
+ <div class='inline'>
1265
+ <p>The resulted post operation</p>
1266
+ </div>
1267
+
1268
+ </li>
1269
+
1270
+ </ul>
1271
+
1272
+ </div><table class="source_code">
1273
+ <tr>
1274
+ <td>
1275
+ <pre class="lines">
1276
+
1277
+
1278
+ 209
1279
+ 210
1280
+ 211
1281
+ 212
1282
+ 213</pre>
1283
+ </td>
1284
+ <td>
1285
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 209</span>
1286
+
1287
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_isilon'>add_isilon</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_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>
1288
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
1289
+ <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'>8080</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>
1290
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_system_payload'>storage_system_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isilon</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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><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-systems</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>
1291
+ <span class='kw'>end</span></pre>
1292
+ </td>
1293
+ </tr>
1294
+ </table>
1295
+ </div>
1296
+
1297
+ <div class="method_details ">
1298
+ <h3 class="signature " id="add_netapp-instance_method">
1299
+
1300
+ - (<tt>Hash</tt>) <strong>add_netapp</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, auth = nil, cert = nil)
1301
+
1302
+
1303
+
1304
+
1305
+
1306
+ </h3><div class="docstring">
1307
+ <div class="discussion">
1308
+
1309
+ <div class="note notetag">
1310
+ <strong>Note:</strong>
1311
+ <div class='inline'>
1312
+ <p>Supported Protocol: NFS, CIFS For supported versions, see the EMC ViPR
1313
+ Support Matrix available on the EMC Community Network (community.emc.com).</p>
1314
+ </div>
1315
+ </div>
1316
+
1317
+
1318
+ <p>Add NetApp Storage Provider</p>
1319
+
1320
+
1321
+ </div>
1322
+ </div>
1323
+ <div class="tags">
1324
+
1325
+ <div class="examples">
1326
+ <p class="tag_title">Examples:</p>
1327
+
1328
+
1329
+ <p class="example_title"><div class='inline'>
1330
+ <p>Add NetApp Storage Provider</p>
1331
+ </div></p>
1332
+
1333
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_netapp'>netapp</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netapp01</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'>netapp01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1334
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_netapp'>netapp</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netapp01</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'>netapp01.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1335
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_netapp'>netapp</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netapp01</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'>netapp01.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'>sysadmin</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'>sysadmin</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'>8093</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
1336
+
1337
+ </div>
1338
+ <p class="tag_title">Parameters:</p>
1339
+ <ul class="param">
1340
+
1341
+ <li>
1342
+
1343
+ <span class='name'>name</span>
1344
+
1345
+
1346
+ <span class='type'>(<tt>String</tt>)</span>
1347
+
1348
+
1349
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1350
+
1351
+
1352
+ &mdash;
1353
+ <div class='inline'>
1354
+ <p>Name of the NetApp Storage Provider. This name is arbitrary and only exists
1355
+ within ViPR. This is a required string.</p>
1356
+ </div>
1357
+
1358
+ </li>
1359
+
1360
+ <li>
1361
+
1362
+ <span class='name'>ip_or_dns</span>
1363
+
1364
+
1365
+ <span class='type'>(<tt>String</tt>)</span>
1366
+
1367
+
1368
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1369
+
1370
+
1371
+ &mdash;
1372
+ <div class='inline'>
1373
+ <p>FQDN or IP Address of the NetApp Storage Provider to add. This is a
1374
+ required string.</p>
1375
+ </div>
1376
+
1377
+ </li>
1378
+
1379
+ <li>
1380
+
1381
+ <span class='name'>user_name</span>
1382
+
1383
+
1384
+ <span class='type'>(<tt>String</tt>)</span>
1385
+
1386
+
1387
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1388
+
1389
+
1390
+ &mdash;
1391
+ <div class='inline'>
1392
+ <p>User Name that will be used for authenticating against the NetApp Storage
1393
+ Provider. This is an optional string. If no parameter is passed, then
1394
+ &#39;admin&#39; is used. If you wish to specify a different password, port,
1395
+ or use_ssl param set this to nil</p>
1396
+ </div>
1397
+
1398
+ </li>
1399
+
1400
+ <li>
1401
+
1402
+ <span class='name'>password</span>
1403
+
1404
+
1405
+ <span class='type'>(<tt>String</tt>)</span>
1406
+
1407
+
1408
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1409
+
1410
+
1411
+ &mdash;
1412
+ <div class='inline'>
1413
+ <p>Password that will be used for authenticating against the NetApp Storage
1414
+ Provider. This is an optional string. If no parameter is passed, then
1415
+ &#39;#1Password&#39; is used. If you wish to specify a different username,
1416
+ port, or use_ssl param set this to nil</p>
1417
+ </div>
1418
+
1419
+ </li>
1420
+
1421
+ <li>
1422
+
1423
+ <span class='name'>port</span>
1424
+
1425
+
1426
+ <span class='type'>(<tt>String</tt>)</span>
1427
+
1428
+
1429
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1430
+
1431
+
1432
+ &mdash;
1433
+ <div class='inline'>
1434
+ <p>Port that will be used for communicating with the NetApp Storage Provider.
1435
+ This is an optional string. If no parameter is passed, then &#39;443&#39;
1436
+ is used. If you wish to specify a different user_name, password, or use_ssl
1437
+ param set this to nil</p>
1438
+ </div>
1439
+
1440
+ </li>
1441
+
1442
+ </ul>
1443
+
1444
+ <p class="tag_title">Returns:</p>
1445
+ <ul class="return">
1446
+
1447
+ <li>
1448
+
1449
+
1450
+ <span class='type'>(<tt>Hash</tt>)</span>
1451
+
1452
+
1453
+
1454
+ &mdash;
1455
+ <div class='inline'>
1456
+ <p>The resulted post operation</p>
1457
+ </div>
1458
+
1459
+ </li>
1460
+
1461
+ </ul>
1462
+
1463
+ </div><table class="source_code">
1464
+ <tr>
1465
+ <td>
1466
+ <pre class="lines">
1467
+
1468
+
1469
+ 257
1470
+ 258
1471
+ 259
1472
+ 260
1473
+ 261</pre>
1474
+ </td>
1475
+ <td>
1476
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 257</span>
1477
+
1478
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_netapp'>add_netapp</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_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>
1479
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
1480
+ <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>
1481
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_system_payload'>storage_system_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>netapp</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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><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-systems</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>
1482
+ <span class='kw'>end</span></pre>
1483
+ </td>
1484
+ </tr>
1485
+ </table>
1486
+ </div>
1487
+
1488
+ <div class="method_details ">
1489
+ <h3 class="signature " id="add_scaleio-instance_method">
1490
+
1491
+ - (<tt>Hash</tt>) <strong>add_scaleio</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, auth = nil, cert = nil)
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+ </h3><div class="docstring">
1498
+ <div class="discussion">
1499
+
1500
+ <div class="note notetag">
1501
+ <strong>Note:</strong>
1502
+ <div class='inline'>
1503
+ <p>Supported versions: ScaleIO 1.21.0.20 or later. Preconfiguration
1504
+ requirements: (1) Protection domains are defined. (2) All storage pools are
1505
+ defined.</p>
1506
+ </div>
1507
+ </div>
1508
+
1509
+
1510
+ <p>Add ScaleIO Storage Systems</p>
1511
+
1512
+
1513
+ </div>
1514
+ </div>
1515
+ <div class="tags">
1516
+
1517
+ <div class="examples">
1518
+ <p class="tag_title">Examples:</p>
1519
+
1520
+
1521
+ <p class="example_title"><div class='inline'>
1522
+ <p>Add ScaleIO Storage System</p>
1523
+ </div></p>
1524
+
1525
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_scaleio'>add_scaleio</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>scaleio01</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'>scaleio01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1526
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_scaleio'>add_scaleio</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>scaleio02</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'>scaleio02.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1527
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_scaleio'>add_scaleio</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>scaleio03</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'>scaleio03.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'>sysadmin</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'>sysadmin</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'>8093</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'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
1528
+
1529
+ </div>
1530
+ <p class="tag_title">Parameters:</p>
1531
+ <ul class="param">
1532
+
1533
+ <li>
1534
+
1535
+ <span class='name'>name</span>
1536
+
1537
+
1538
+ <span class='type'>(<tt>String</tt>)</span>
1539
+
1540
+
1541
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1542
+
1543
+
1544
+ &mdash;
1545
+ <div class='inline'>
1546
+ <p>Name of the ScaleIO Storage System. This name is arbitrary and only exists
1547
+ within ViPR. This is a required string.</p>
1548
+ </div>
1549
+
1550
+ </li>
1551
+
1552
+ <li>
1553
+
1554
+ <span class='name'>ip_or_dns</span>
1555
+
1556
+
1557
+ <span class='type'>(<tt>String</tt>)</span>
1558
+
1559
+
1560
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1561
+
1562
+
1563
+ &mdash;
1564
+ <div class='inline'>
1565
+ <p>FQDN or IP Address of the ScaleIO Storage System to add. This is a required
1566
+ string.</p>
1567
+ </div>
1568
+
1569
+ </li>
1570
+
1571
+ <li>
1572
+
1573
+ <span class='name'>user_name</span>
1574
+
1575
+
1576
+ <span class='type'>(<tt>String</tt>)</span>
1577
+
1578
+
1579
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1580
+
1581
+
1582
+ &mdash;
1583
+ <div class='inline'>
1584
+ <p>User Name that will be used for authenticating against the ScaleIO Storage
1585
+ System. This is an optional string. If no parameter is passed, then
1586
+ &#39;admin&#39; is used. If you wish to specify a different password, port,
1587
+ or use_ssl param set this to nil</p>
1588
+ </div>
1589
+
1590
+ </li>
1591
+
1592
+ <li>
1593
+
1594
+ <span class='name'>password</span>
1595
+
1596
+
1597
+ <span class='type'>(<tt>String</tt>)</span>
1598
+
1599
+
1600
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1601
+
1602
+
1603
+ &mdash;
1604
+ <div class='inline'>
1605
+ <p>Password that will be used for authenticating against the ScaleIO Storage
1606
+ System. This is an optional string. If no parameter is passed, then
1607
+ &#39;#1Password&#39; is used. If you wish to specify a different username,
1608
+ port, or use_ssl param set this to nil</p>
1609
+ </div>
1610
+
1611
+ </li>
1612
+
1613
+ <li>
1614
+
1615
+ <span class='name'>port</span>
1616
+
1617
+
1618
+ <span class='type'>(<tt>String</tt>)</span>
1619
+
1620
+
1621
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1622
+
1623
+
1624
+ &mdash;
1625
+ <div class='inline'>
1626
+ <p>Port that will be used for communicating with the ScaleIO Storage System.
1627
+ This is an optional string. If no parameter is passed, then &#39;22&#39; is
1628
+ used. If you wish to specify a different user_name, password, or use_ssl
1629
+ param set this to nil</p>
1630
+ </div>
1631
+
1632
+ </li>
1633
+
1634
+ <li>
1635
+
1636
+ <span class='name'>use_ssl</span>
1637
+
1638
+
1639
+ <span class='type'>(<tt>String</tt>)</span>
1640
+
1641
+
1642
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1643
+
1644
+
1645
+ &mdash;
1646
+ <div class='inline'>
1647
+ <p>SSL setting for communicating with the ScaleIO Storage System. This is an
1648
+ optional string. If no parameter is passed, then &#39;false&#39; is used.</p>
1649
+ </div>
1650
+
1651
+ </li>
1652
+
1653
+ </ul>
1654
+
1655
+ <p class="tag_title">Returns:</p>
1656
+ <ul class="return">
1657
+
1658
+ <li>
1659
+
1660
+
1661
+ <span class='type'>(<tt>Hash</tt>)</span>
1662
+
1663
+
1664
+
1665
+ &mdash;
1666
+ <div class='inline'>
1667
+ <p>The resulted post operation</p>
1668
+ </div>
1669
+
1670
+ </li>
1671
+
1672
+ </ul>
1673
+
1674
+ </div><table class="source_code">
1675
+ <tr>
1676
+ <td>
1677
+ <pre class="lines">
1678
+
1679
+
1680
+ 164
1681
+ 165
1682
+ 166
1683
+ 167
1684
+ 168</pre>
1685
+ </td>
1686
+ <td>
1687
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 164</span>
1688
+
1689
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_scaleio'>add_scaleio</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_use_ssl'>use_ssl</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>
1690
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
1691
+ <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'>22</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>
1692
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_provider_payload'>storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>scaleio</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='rparen'>)</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-providers</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>
1693
+ <span class='kw'>end</span></pre>
1694
+ </td>
1695
+ </tr>
1696
+ </table>
1697
+ </div>
1698
+
1699
+ <div class="method_details ">
1700
+ <h3 class="signature " id="add_third_party_block-instance_method">
1701
+
1702
+ - (<tt>Hash</tt>) <strong>add_third_party_block</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, auth = nil, cert = nil)
1703
+
1704
+
1705
+
1706
+
1707
+
1708
+ </h3><div class="docstring">
1709
+ <div class="discussion">
1710
+
1711
+ <div class="note notetag">
1712
+ <strong>Note:</strong>
1713
+ <div class='inline'>
1714
+ <p>ViPR uses the OpenStack Block Storage (Cinder) Service to add third-party
1715
+ block storage systems to ViPR. For supported versions, see the EMC ViPR
1716
+ Support Matrix available on the EMC Community Network (community.emc.com).</p>
1717
+ </div>
1718
+ </div>
1719
+
1720
+
1721
+ <p>Add Third Party Block Storage Provider</p>
1722
+
1723
+
1724
+ </div>
1725
+ </div>
1726
+ <div class="tags">
1727
+
1728
+ <div class="examples">
1729
+ <p class="tag_title">Examples:</p>
1730
+
1731
+
1732
+ <p class="example_title"><div class='inline'>
1733
+ <p>Add Third Party Block Storage Provider</p>
1734
+ </div></p>
1735
+
1736
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_third_party_block'>add_third_party_block</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cinder01</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'>cinder01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1737
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_third_party_block'>add_third_party_block</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cinder01</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'>cinder01.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1738
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_third_party_block'>add_third_party_block</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cinder01</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'>cinder01.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'>sysadmin</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'>sysadmin</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'>8093</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'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
1739
+
1740
+ </div>
1741
+ <p class="tag_title">Parameters:</p>
1742
+ <ul class="param">
1743
+
1744
+ <li>
1745
+
1746
+ <span class='name'>name</span>
1747
+
1748
+
1749
+ <span class='type'>(<tt>String</tt>)</span>
1750
+
1751
+
1752
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1753
+
1754
+
1755
+ &mdash;
1756
+ <div class='inline'>
1757
+ <p>Name of the Third Party Block Storage Provider. This name is arbitrary and
1758
+ only exists within ViPR. This is a required string.</p>
1759
+ </div>
1760
+
1761
+ </li>
1762
+
1763
+ <li>
1764
+
1765
+ <span class='name'>ip_or_dns</span>
1766
+
1767
+
1768
+ <span class='type'>(<tt>String</tt>)</span>
1769
+
1770
+
1771
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1772
+
1773
+
1774
+ &mdash;
1775
+ <div class='inline'>
1776
+ <p>FQDN or IP Address of the Third Party Block Storage Provider to add. This
1777
+ is a required string.</p>
1778
+ </div>
1779
+
1780
+ </li>
1781
+
1782
+ <li>
1783
+
1784
+ <span class='name'>user_name</span>
1785
+
1786
+
1787
+ <span class='type'>(<tt>String</tt>)</span>
1788
+
1789
+
1790
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1791
+
1792
+
1793
+ &mdash;
1794
+ <div class='inline'>
1795
+ <p>User Name that will be used for authenticating against the Third Party
1796
+ Block Storage Provider. This is an optional string. If no parameter is
1797
+ passed, then &#39;admin&#39; is used. If you wish to specify a different
1798
+ password, port, or use_ssl param set this to nil</p>
1799
+ </div>
1800
+
1801
+ </li>
1802
+
1803
+ <li>
1804
+
1805
+ <span class='name'>password</span>
1806
+
1807
+
1808
+ <span class='type'>(<tt>String</tt>)</span>
1809
+
1810
+
1811
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1812
+
1813
+
1814
+ &mdash;
1815
+ <div class='inline'>
1816
+ <p>Password that will be used for authenticating against the Third Party Block
1817
+ Storage Provider. This is an optional string. If no parameter is passed,
1818
+ then &#39;#1Password&#39; is used. If you wish to specify a different
1819
+ username, port, or use_ssl param set this to nil</p>
1820
+ </div>
1821
+
1822
+ </li>
1823
+
1824
+ <li>
1825
+
1826
+ <span class='name'>port</span>
1827
+
1828
+
1829
+ <span class='type'>(<tt>String</tt>)</span>
1830
+
1831
+
1832
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1833
+
1834
+
1835
+ &mdash;
1836
+ <div class='inline'>
1837
+ <p>Port that will be used for communicating with the Third Party Block Storage
1838
+ Provider. This is an optional string. If no parameter is passed, then
1839
+ &#39;22&#39; is used. If you wish to specify a different user_name,
1840
+ password, or use_ssl param set this to nil</p>
1841
+ </div>
1842
+
1843
+ </li>
1844
+
1845
+ <li>
1846
+
1847
+ <span class='name'>use_ssl</span>
1848
+
1849
+
1850
+ <span class='type'>(<tt>String</tt>)</span>
1851
+
1852
+
1853
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1854
+
1855
+
1856
+ &mdash;
1857
+ <div class='inline'>
1858
+ <p>SSL setting for communicating with the Third Party Block Storage Provider.
1859
+ This is an optional string. If no parameter is passed, then &#39;false&#39;
1860
+ is used.</p>
1861
+ </div>
1862
+
1863
+ </li>
1864
+
1865
+ </ul>
1866
+
1867
+ <p class="tag_title">Returns:</p>
1868
+ <ul class="return">
1869
+
1870
+ <li>
1871
+
1872
+
1873
+ <span class='type'>(<tt>Hash</tt>)</span>
1874
+
1875
+
1876
+
1877
+ &mdash;
1878
+ <div class='inline'>
1879
+ <p>The resulted post operation</p>
1880
+ </div>
1881
+
1882
+ </li>
1883
+
1884
+ </ul>
1885
+
1886
+ </div><table class="source_code">
1887
+ <tr>
1888
+ <td>
1889
+ <pre class="lines">
1890
+
1891
+
1892
+ 187
1893
+ 188
1894
+ 189
1895
+ 190
1896
+ 191</pre>
1897
+ </td>
1898
+ <td>
1899
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 187</span>
1900
+
1901
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_third_party_block'>add_third_party_block</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_use_ssl'>use_ssl</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>
1902
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
1903
+ <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'>22</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>
1904
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_provider_payload'>storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cinder</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='rparen'>)</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-providers</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>
1905
+ <span class='kw'>end</span></pre>
1906
+ </td>
1907
+ </tr>
1908
+ </table>
1909
+ </div>
1910
+
1911
+ <div class="method_details ">
1912
+ <h3 class="signature " id="add_vplex-instance_method">
1913
+
1914
+ - (<tt>Hash</tt>) <strong>add_vplex</strong>(name = nil, ip_or_dns = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, auth = nil, cert = nil)
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+ </h3><div class="docstring">
1921
+ <div class="discussion">
1922
+
1923
+ <div class="note notetag">
1924
+ <strong>Note:</strong>
1925
+ <div class='inline'>
1926
+ <p>ViPR supports VPLEX in a Local or Metro configuration. VPLEX Geo
1927
+ configurations are not supported.</p>
1928
+ </div>
1929
+ </div>
1930
+
1931
+
1932
+ <p>Add VPLEX Storage Systems</p>
1933
+
1934
+
1935
+ </div>
1936
+ </div>
1937
+ <div class="tags">
1938
+
1939
+ <div class="examples">
1940
+ <p class="tag_title">Examples:</p>
1941
+
1942
+
1943
+ <p class="example_title"><div class='inline'>
1944
+ <p>Add VPLEX Storage System</p>
1945
+ </div></p>
1946
+
1947
+ <pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_vplex'>add_vplex</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>VPLEX01</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'>VPLEX01.mydomain.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1948
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_vplex'>add_vplex</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>VPLEX02</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'>VPLEX02.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'>sysadmin</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'>sysadmin</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1949
+ <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_vplex'>add_vplex</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>VPLEX03</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'>VPLEX03.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'>sysadmin</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'>sysadmin</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'>8093</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'>true</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
1950
+
1951
+ </div>
1952
+ <p class="tag_title">Parameters:</p>
1953
+ <ul class="param">
1954
+
1955
+ <li>
1956
+
1957
+ <span class='name'>name</span>
1958
+
1959
+
1960
+ <span class='type'>(<tt>String</tt>)</span>
1961
+
1962
+
1963
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1964
+
1965
+
1966
+ &mdash;
1967
+ <div class='inline'>
1968
+ <p>Name of the VPLEX Device. This name is arbitrary and only exists within
1969
+ ViPR. This is a required string.</p>
1970
+ </div>
1971
+
1972
+ </li>
1973
+
1974
+ <li>
1975
+
1976
+ <span class='name'>ip_or_dns</span>
1977
+
1978
+
1979
+ <span class='type'>(<tt>String</tt>)</span>
1980
+
1981
+
1982
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1983
+
1984
+
1985
+ &mdash;
1986
+ <div class='inline'>
1987
+ <p>FQDN or IP Address of the VPLEX Device to add. This is a required string.</p>
1988
+ </div>
1989
+
1990
+ </li>
1991
+
1992
+ <li>
1993
+
1994
+ <span class='name'>user_name</span>
1995
+
1996
+
1997
+ <span class='type'>(<tt>String</tt>)</span>
1998
+
1999
+
2000
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2001
+
2002
+
2003
+ &mdash;
2004
+ <div class='inline'>
2005
+ <p>User Name that will be used for authenticating against the VPLEX Device.
2006
+ This is an optional string. If no parameter is passed, then &#39;admin&#39;
2007
+ is used. If you wish to specify a different password, port, or use_ssl
2008
+ param set this to nil</p>
2009
+ </div>
2010
+
2011
+ </li>
2012
+
2013
+ <li>
2014
+
2015
+ <span class='name'>password</span>
2016
+
2017
+
2018
+ <span class='type'>(<tt>String</tt>)</span>
2019
+
2020
+
2021
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2022
+
2023
+
2024
+ &mdash;
2025
+ <div class='inline'>
2026
+ <p>Password that will be used for authenticating against the VPLEX Device.
2027
+ This is an optional string. If no parameter is passed, then
2028
+ &#39;#1Password&#39; is used. If you wish to specify a different username,
2029
+ port, or use_ssl param set this to nil</p>
2030
+ </div>
2031
+
2032
+ </li>
2033
+
2034
+ <li>
2035
+
2036
+ <span class='name'>port</span>
2037
+
2038
+
2039
+ <span class='type'>(<tt>String</tt>)</span>
2040
+
2041
+
2042
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2043
+
2044
+
2045
+ &mdash;
2046
+ <div class='inline'>
2047
+ <p>Port that will be used for communicating with the VPLEX Device. This is an
2048
+ optional string. If no parameter is passed, then &#39;443&#39; is used. If
2049
+ you wish to specify a different user_name, password, or use_ssl param set
2050
+ this to nil</p>
2051
+ </div>
2052
+
2053
+ </li>
2054
+
2055
+ <li>
2056
+
2057
+ <span class='name'>use_ssl</span>
2058
+
2059
+
2060
+ <span class='type'>(<tt>String</tt>)</span>
2061
+
2062
+
2063
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2064
+
2065
+
2066
+ &mdash;
2067
+ <div class='inline'>
2068
+ <p>SSL setting for communicating with the VPLEX Device. This is an optional
2069
+ string. If no parameter is passed, then &#39;false&#39; is used.</p>
2070
+ </div>
2071
+
2072
+ </li>
2073
+
2074
+ </ul>
2075
+
2076
+ <p class="tag_title">Returns:</p>
2077
+ <ul class="return">
2078
+
2079
+ <li>
2080
+
2081
+
2082
+ <span class='type'>(<tt>Hash</tt>)</span>
2083
+
2084
+
2085
+
2086
+ &mdash;
2087
+ <div class='inline'>
2088
+ <p>The resulted post operation</p>
2089
+ </div>
2090
+
2091
+ </li>
2092
+
2093
+ </ul>
2094
+
2095
+ </div><table class="source_code">
2096
+ <tr>
2097
+ <td>
2098
+ <pre class="lines">
2099
+
2100
+
2101
+ 139
2102
+ 140
2103
+ 141
2104
+ 142
2105
+ 143</pre>
2106
+ </td>
2107
+ <td>
2108
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 139</span>
2109
+
2110
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_vplex'>add_vplex</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</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_use_ssl'>use_ssl</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>
2111
+ <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='rparen'>)</span>
2112
+ <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>
2113
+ <span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_provider_payload'>storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>vplex</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='rparen'>)</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-providers</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>
2114
+ <span class='kw'>end</span></pre>
2115
+ </td>
2116
+ </tr>
2117
+ </table>
2118
+ </div>
2119
+
2120
+ <div class="method_details ">
2121
+ <h3 class="signature " id="check_storage_provider_payload-instance_method">
2122
+
2123
+ - (<tt>Boolean</tt>) <strong>check_storage_provider_payload</strong>(name = nil, ip_or_dns = nil) <span class="extras">(private)</span>
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+ </h3><div class="docstring">
2130
+ <div class="discussion">
2131
+
2132
+ <p>Error Handling method to check for Missing Param. If the pass fails, an
2133
+ error exception is raised</p>
2134
+
2135
+
2136
+ </div>
2137
+ </div>
2138
+ <div class="tags">
2139
+ <p class="tag_title">Parameters:</p>
2140
+ <ul class="param">
2141
+
2142
+ <li>
2143
+
2144
+ <span class='name'>name</span>
2145
+
2146
+
2147
+ <span class='type'>(<tt>String</tt>)</span>
2148
+
2149
+
2150
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2151
+
2152
+
2153
+ &mdash;
2154
+ <div class='inline'>
2155
+ <p>Name of the Storage Provider. This name is arbitrary and only exists within
2156
+ ViPR. This is a required string.</p>
2157
+ </div>
2158
+
2159
+ </li>
2160
+
2161
+ <li>
2162
+
2163
+ <span class='name'>ip_or_dns</span>
2164
+
2165
+
2166
+ <span class='type'>(<tt>String</tt>)</span>
2167
+
2168
+
2169
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2170
+
2171
+
2172
+ &mdash;
2173
+ <div class='inline'>
2174
+ <p>FQDN or IP Address of the Storage Provider to add. This is a required
2175
+ string.</p>
2176
+ </div>
2177
+
2178
+ </li>
2179
+
2180
+ </ul>
2181
+
2182
+ <p class="tag_title">Returns:</p>
2183
+ <ul class="return">
2184
+
2185
+ <li>
2186
+
2187
+
2188
+ <span class='type'>(<tt>Boolean</tt>)</span>
2189
+
2190
+
2191
+
2192
+ &mdash;
2193
+ <div class='inline'>
2194
+ <p>True if passes. If fails, raise exception</p>
2195
+ </div>
2196
+
2197
+ </li>
2198
+
2199
+ </ul>
2200
+
2201
+ </div><table class="source_code">
2202
+ <tr>
2203
+ <td>
2204
+ <pre class="lines">
2205
+
2206
+
2207
+ 272
2208
+ 273
2209
+ 274
2210
+ 275
2211
+ 276</pre>
2212
+ </td>
2213
+ <td>
2214
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 272</span>
2215
+
2216
+ <span class='kw'>def</span> <span class='id identifier rubyid_check_storage_provider_payload'>check_storage_provider_payload</span><span class='lparen'>(</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_ip_or_dns'>ip_or_dns</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
2217
+ <span class='kw'>if</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_ip_or_dns'>ip_or_dns</span> <span class='op'>==</span> <span class='kw'>nil</span>
2218
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing Param &#39;name&#39; or &#39;ip_or_dns&#39;</span><span class='tstring_end'>&quot;</span></span>
2219
+ <span class='kw'>end</span>
2220
+ <span class='kw'>end</span></pre>
2221
+ </td>
2222
+ </tr>
2223
+ </table>
2224
+ </div>
2225
+
2226
+ <div class="method_details ">
2227
+ <h3 class="signature " id="storage_provider_payload-instance_method">
2228
+
2229
+ - (<tt>JSON</tt>) <strong>storage_provider_payload</strong>(name, interface_type, ip_or_dns, port, user_name, password, use_ssl)
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+ </h3><div class="docstring">
2236
+ <div class="discussion">
2237
+
2238
+ <p>Returns The JSON structure for the post operation</p>
2239
+
2240
+
2241
+ </div>
2242
+ </div>
2243
+ <div class="tags">
2244
+ <p class="tag_title">Parameters:</p>
2245
+ <ul class="param">
2246
+
2247
+ <li>
2248
+
2249
+ <span class='name'>port</span>
2250
+
2251
+
2252
+ <span class='type'>(<tt>String</tt>)</span>
2253
+
2254
+
2255
+
2256
+ &mdash;
2257
+ <div class='inline'>
2258
+ <p>Port of the Storage Provider. This is a required string. This generated
2259
+ automatically based on the method call for types of storage providers. This
2260
+ is a required string. This can be modified based depending upon the storage
2261
+ system method call</p>
2262
+ </div>
2263
+
2264
+ </li>
2265
+
2266
+ <li>
2267
+
2268
+ <span class='name'>user_name</span>
2269
+
2270
+
2271
+ <span class='type'>(<tt>String</tt>)</span>
2272
+
2273
+
2274
+
2275
+ &mdash;
2276
+ <div class='inline'>
2277
+ <p>User Name that will be used for authenticating against the Storage
2278
+ Provider. This is a required string. If a User Name is not provided, then
2279
+ &#39;admin&#39; is used</p>
2280
+ </div>
2281
+
2282
+ </li>
2283
+
2284
+ <li>
2285
+
2286
+ <span class='name'>password</span>
2287
+
2288
+
2289
+ <span class='type'>(<tt>String</tt>)</span>
2290
+
2291
+
2292
+
2293
+ &mdash;
2294
+ <div class='inline'>
2295
+ <p>Password for the user_name that will be used for authenticating against the
2296
+ Storage Provider. This is a required string. If a Password is not provided,
2297
+ then &#39;#1Password&#39; is used</p>
2298
+ </div>
2299
+
2300
+ </li>
2301
+
2302
+ <li>
2303
+
2304
+ <span class='name'>use_ssl</span>
2305
+
2306
+
2307
+ <span class='type'>(<tt>Boolean</tt>)</span>
2308
+
2309
+
2310
+
2311
+ &mdash;
2312
+ <div class='inline'>
2313
+ <p>Specify true or false for communicating to the Storage Provider. This is a
2314
+ required string, and will default to false unless &#39;true&#39; is
2315
+ specified</p>
2316
+ </div>
2317
+
2318
+ </li>
2319
+
2320
+ </ul>
2321
+
2322
+ <p class="tag_title">Returns:</p>
2323
+ <ul class="return">
2324
+
2325
+ <li>
2326
+
2327
+
2328
+ <span class='type'>(<tt>JSON</tt>)</span>
2329
+
2330
+
2331
+
2332
+ &mdash;
2333
+ <div class='inline'>
2334
+ <p>The JSON structure for the post operation</p>
2335
+ </div>
2336
+
2337
+ </li>
2338
+
2339
+ </ul>
2340
+
2341
+ </div><table class="source_code">
2342
+ <tr>
2343
+ <td>
2344
+ <pre class="lines">
2345
+
2346
+
2347
+ 17
2348
+ 18
2349
+ 19
2350
+ 20
2351
+ 21
2352
+ 22
2353
+ 23
2354
+ 24
2355
+ 25
2356
+ 26
2357
+ 27
2358
+ 28
2359
+ 29</pre>
2360
+ </td>
2361
+ <td>
2362
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 17</span>
2363
+
2364
+ <span class='kw'>def</span> <span class='id identifier rubyid_storage_provider_payload'>storage_provider_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_interface_type'>interface_type</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='rparen'>)</span>
2365
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
2366
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
2367
+ <span class='label'>interface_type:</span> <span class='id identifier rubyid_interface_type'>interface_type</span><span class='comma'>,</span>
2368
+ <span class='label'>ip_address:</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span>
2369
+ <span class='label'>port_number:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
2370
+ <span class='label'>user_name:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span>
2371
+ <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#1Password</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
2372
+ <span class='label'>use_ssl:</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span>
2373
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
2374
+
2375
+ <span class='kw'>return</span> <span class='id identifier rubyid_payload'>payload</span>
2376
+ <span class='kw'>end</span></pre>
2377
+ </td>
2378
+ </tr>
2379
+ </table>
2380
+ </div>
2381
+
2382
+ <div class="method_details ">
2383
+ <h3 class="signature " id="storage_system_payload-instance_method">
2384
+
2385
+ - (<tt>JSON</tt>) <strong>storage_system_payload</strong>(name, system_type, ip_or_dns, port, user_name, password, smis_provider_ip = nil, smis_port_number = nil, smis_user_name = nil, smis_password = nil, smis_use_ssl = nil)
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+ </h3><div class="docstring">
2392
+ <div class="discussion">
2393
+
2394
+ <p>Returns The JSON structure for the post operation</p>
2395
+
2396
+
2397
+ </div>
2398
+ </div>
2399
+ <div class="tags">
2400
+ <p class="tag_title">Parameters:</p>
2401
+ <ul class="param">
2402
+
2403
+ <li>
2404
+
2405
+ <span class='name'>system_type</span>
2406
+
2407
+
2408
+ <span class='type'>(<tt>String</tt>)</span>
2409
+
2410
+
2411
+
2412
+ &mdash;
2413
+ <div class='inline'>
2414
+ <p>Interface type of the Storage System. This generated automatically based on
2415
+ the method call for types of storage providers. This is a required string.</p>
2416
+ </div>
2417
+
2418
+ </li>
2419
+
2420
+ <li>
2421
+
2422
+ <span class='name'>ip_or_dns</span>
2423
+
2424
+
2425
+ <span class='type'>(<tt>String</tt>)</span>
2426
+
2427
+
2428
+
2429
+ &mdash;
2430
+ <div class='inline'>
2431
+ <p>IP Address or FQDN of the Storage System. This is a required string.</p>
2432
+ </div>
2433
+
2434
+ </li>
2435
+
2436
+ <li>
2437
+
2438
+ <span class='name'>port</span>
2439
+
2440
+
2441
+ <span class='type'>(<tt>String</tt>)</span>
2442
+
2443
+
2444
+
2445
+ &mdash;
2446
+ <div class='inline'>
2447
+ <p>Port of the Storage System. This is a required string. This generated
2448
+ automatically based on the method call for types of storage providers. This
2449
+ is a required string. This can be modified based depending upon the storage
2450
+ system method call</p>
2451
+ </div>
2452
+
2453
+ </li>
2454
+
2455
+ <li>
2456
+
2457
+ <span class='name'>user_name</span>
2458
+
2459
+
2460
+ <span class='type'>(<tt>String</tt>)</span>
2461
+
2462
+
2463
+
2464
+ &mdash;
2465
+ <div class='inline'>
2466
+ <p>User Name that will be used for authenticating against the Storage System.
2467
+ This is a required string. If a User Name is not provided, then
2468
+ &#39;admin&#39; is used</p>
2469
+ </div>
2470
+
2471
+ </li>
2472
+
2473
+ <li>
2474
+
2475
+ <span class='name'>password</span>
2476
+
2477
+
2478
+ <span class='type'>(<tt>String</tt>)</span>
2479
+
2480
+
2481
+
2482
+ &mdash;
2483
+ <div class='inline'>
2484
+ <p>Password for the user_name that will be used for authenticating against the
2485
+ Storage System. This is a required string. If a Password is not provided,
2486
+ then &#39;#1Password&#39; is used</p>
2487
+ </div>
2488
+
2489
+ </li>
2490
+
2491
+ <li>
2492
+
2493
+ <span class='name'>smis_provider_ip</span>
2494
+
2495
+
2496
+ <span class='type'>(<tt>String</tt>)</span>
2497
+
2498
+
2499
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2500
+
2501
+
2502
+ &mdash;
2503
+ <div class='inline'>
2504
+ <p>IP Address or FQDN of the SMI-S Provider for the Storage System. This is a
2505
+ required string. Only used for <span class='object_link'><a href="#add_emc_file-instance_method" title="ViprStorageSystem#add_emc_file (method)">#add_emc_file</a></span> method</p>
2506
+ </div>
2507
+
2508
+ </li>
2509
+
2510
+ <li>
2511
+
2512
+ <span class='name'>smis_port_number</span>
2513
+
2514
+
2515
+ <span class='type'>(<tt>String</tt>)</span>
2516
+
2517
+
2518
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2519
+
2520
+
2521
+ &mdash;
2522
+ <div class='inline'>
2523
+ <p>Port Number of the SMI-S Provider for the Storage System. This is a
2524
+ required string, and will default to &#39;5988&#39; unless something else
2525
+ is specified. Only used for <span class='object_link'><a href="#add_emc_file-instance_method" title="ViprStorageSystem#add_emc_file (method)">#add_emc_file</a></span> method</p>
2526
+ </div>
2527
+
2528
+ </li>
2529
+
2530
+ <li>
2531
+
2532
+ <span class='name'>smis_user_name</span>
2533
+
2534
+
2535
+ <span class='type'>(<tt>String</tt>)</span>
2536
+
2537
+
2538
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2539
+
2540
+
2541
+ &mdash;
2542
+ <div class='inline'>
2543
+ <p>User Name that will be used for authenticating against the SMI-S Provider
2544
+ to the Storage System. This is a required string, and will default to
2545
+ &#39;admin&#39; unless something else is specified. Only used for
2546
+ <span class='object_link'><a href="#add_emc_file-instance_method" title="ViprStorageSystem#add_emc_file (method)">#add_emc_file</a></span> method</p>
2547
+ </div>
2548
+
2549
+ </li>
2550
+
2551
+ <li>
2552
+
2553
+ <span class='name'>smis_password</span>
2554
+
2555
+
2556
+ <span class='type'>(<tt>String</tt>)</span>
2557
+
2558
+
2559
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2560
+
2561
+
2562
+ &mdash;
2563
+ <div class='inline'>
2564
+ <p>Password that will be used for authenticating against the SMI-S Provider to
2565
+ the Storage System. This is a required string, and will default to
2566
+ &#39;#1Password&#39; unless something else is specified. Only used for
2567
+ <span class='object_link'><a href="#add_emc_file-instance_method" title="ViprStorageSystem#add_emc_file (method)">#add_emc_file</a></span> method</p>
2568
+ </div>
2569
+
2570
+ </li>
2571
+
2572
+ <li>
2573
+
2574
+ <span class='name'>smis_use_ssl</span>
2575
+
2576
+
2577
+ <span class='type'>(<tt>Boolean</tt>)</span>
2578
+
2579
+
2580
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
2581
+
2582
+
2583
+ &mdash;
2584
+ <div class='inline'>
2585
+ <p>Specify true or false for communicating to the Storage System. This is a
2586
+ required string, and will default to false unless true is passed. Only used
2587
+ for <span class='object_link'><a href="#add_emc_file-instance_method" title="ViprStorageSystem#add_emc_file (method)">#add_emc_file</a></span> method</p>
2588
+ </div>
2589
+
2590
+ </li>
2591
+
2592
+ </ul>
2593
+
2594
+ <p class="tag_title">Returns:</p>
2595
+ <ul class="return">
2596
+
2597
+ <li>
2598
+
2599
+
2600
+ <span class='type'>(<tt>JSON</tt>)</span>
2601
+
2602
+
2603
+
2604
+ &mdash;
2605
+ <div class='inline'>
2606
+ <p>The JSON structure for the post operation</p>
2607
+ </div>
2608
+
2609
+ </li>
2610
+
2611
+ </ul>
2612
+
2613
+ </div><table class="source_code">
2614
+ <tr>
2615
+ <td>
2616
+ <pre class="lines">
2617
+
2618
+
2619
+ 46
2620
+ 47
2621
+ 48
2622
+ 49
2623
+ 50
2624
+ 51
2625
+ 52
2626
+ 53
2627
+ 54
2628
+ 55
2629
+ 56
2630
+ 57
2631
+ 58
2632
+ 59
2633
+ 60
2634
+ 61
2635
+ 62
2636
+ 63
2637
+ 64
2638
+ 65
2639
+ 66
2640
+ 67
2641
+ 68
2642
+ 69
2643
+ 70
2644
+ 71
2645
+ 72
2646
+ 73</pre>
2647
+ </td>
2648
+ <td>
2649
+ <pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagesystem.rb', line 46</span>
2650
+
2651
+ <span class='kw'>def</span> <span class='id identifier rubyid_storage_system_payload'>storage_system_payload</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_system_type'>system_type</span><span class='comma'>,</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</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='comma'>,</span> <span class='id identifier rubyid_smis_provider_ip'>smis_provider_ip</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_user_name'>smis_user_name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_password'>smis_password</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_smis_use_ssl'>smis_use_ssl</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
2652
+ <span class='kw'>if</span> <span class='id identifier rubyid_smis_provider_ip'>smis_provider_ip</span> <span class='op'>==</span> <span class='kw'>nil</span>
2653
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
2654
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
2655
+ <span class='label'>system_type:</span> <span class='id identifier rubyid_system_type'>system_type</span><span class='comma'>,</span>
2656
+ <span class='label'>ip_address:</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span>
2657
+ <span class='label'>port_number:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
2658
+ <span class='label'>user_name:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span>
2659
+ <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#1Password</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
2660
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
2661
+ <span class='kw'>else</span>
2662
+ <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
2663
+ <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
2664
+ <span class='label'>system_type:</span> <span class='id identifier rubyid_system_type'>system_type</span><span class='comma'>,</span>
2665
+ <span class='label'>ip_address:</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span>
2666
+ <span class='label'>port_number:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
2667
+ <span class='label'>user_name:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span>
2668
+ <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#1Password</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
2669
+ <span class='label'>smis_provider_ip:</span> <span class='id identifier rubyid_smis_provider_ip'>smis_provider_ip</span><span class='comma'>,</span>
2670
+ <span class='label'>smis_port_number:</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>5988</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_smis_port_number'>smis_port_number</span><span class='comma'>,</span>
2671
+ <span class='label'>smis_user_name:</span> <span class='id identifier rubyid_smis_user_name'>smis_user_name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_smis_user_name'>smis_user_name</span><span class='comma'>,</span>
2672
+ <span class='label'>smis_password:</span> <span class='id identifier rubyid_smis_password'>smis_password</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>#1Password</span><span class='tstring_end'>&#39;</span></span> <span class='op'>:</span> <span class='id identifier rubyid_smis_password'>smis_password</span><span class='comma'>,</span>
2673
+ <span class='label'>smis_use_ssl:</span> <span class='id identifier rubyid_smis_use_ssl'>smis_use_ssl</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='id identifier rubyid_smis_use_ssl'>smis_use_ssl</span>
2674
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
2675
+ <span class='kw'>end</span>
2676
+
2677
+ <span class='kw'>return</span> <span class='id identifier rubyid_payload'>payload</span>
2678
+ <span class='kw'>end</span></pre>
2679
+ </td>
2680
+ </tr>
2681
+ </table>
2682
+ </div>
2683
+
2684
+ </div>
2685
+
2686
+ </div>
2687
+
2688
+ <div id="footer">
2689
+ Generated on Mon Dec 15 13:52:44 2014 by
2690
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2691
+ 0.8.7.6 (ruby-2.1.2).
2692
+ </div>
2693
+
2694
+ </body>
2695
+ </html>