vipruby 0.1.4 → 0.1.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +3 -0
- data/.yardoc/checksums +7 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/.yardopts +1 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +22 -0
- data/LICENSE.txt +22 -0
- data/README.md +49 -0
- data/Rakefile +2 -0
- data/doc/Host.html +910 -0
- data/doc/Vipr.html +656 -0
- data/doc/ViprBase.html +928 -0
- data/doc/ViprHost.html +1952 -0
- data/doc/ViprStorageSystem.html +2695 -0
- data/doc/ViprVcenter.html +1540 -0
- data/doc/Vipruby.html +139 -0
- data/doc/Vipruby/Auth.html +745 -0
- data/doc/_index.html +135 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +121 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +121 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +333 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/.yardoc/checksums +0 -0
- data/lib/.yardoc/object_types +0 -0
- data/lib/.yardoc/objects/root.dat +0 -0
- data/lib/.yardoc/proxy_types +0 -0
- data/lib/vipruby.rb +6 -426
- data/lib/vipruby/.yardoc/checksums +0 -0
- data/lib/vipruby/.yardoc/object_types +0 -0
- data/lib/vipruby/.yardoc/objects/root.dat +0 -0
- data/lib/vipruby/.yardoc/proxy_types +0 -0
- data/lib/vipruby/objects/host.rb +234 -0
- data/lib/vipruby/objects/storagesystem.rb +278 -0
- data/lib/vipruby/objects/vcenter.rb +162 -0
- data/lib/vipruby/version.rb +6 -0
- data/lib/vipruby/vipr.rb +45 -0
- data/lib/vipruby/viprbase.rb +84 -0
- data/vipruby.gemspec +29 -0
- metadata +100 -9
data/doc/ViprHost.html
ADDED
|
@@ -0,0 +1,1952 @@
|
|
|
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: ViprHost
|
|
8
|
+
|
|
9
|
+
— 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#!ViprHost.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> »
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
<span class="title">ViprHost</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: ViprHost
|
|
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/host.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 Host calls will get Host information for all tenants</p>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
<div class="tags">
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<h2>
|
|
111
|
+
Instance Method Summary
|
|
112
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
113
|
+
</h2>
|
|
114
|
+
|
|
115
|
+
<ul class="summary">
|
|
116
|
+
|
|
117
|
+
<li class="public ">
|
|
118
|
+
<span class="summary_signature">
|
|
119
|
+
|
|
120
|
+
<a href="#add_host-instance_method" title="#add_host (instance method)">- (JSON) <strong>add_host</strong>(host_type = nil, ip_or_dns = nil, name = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, discoverable = nil, auth = nil, cert = nil) </a>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</span>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<span class="summary_desc"><div class='inline'>
|
|
135
|
+
<p>Add a host to ViPR.</p>
|
|
136
|
+
</div></span>
|
|
137
|
+
|
|
138
|
+
</li>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#add_host_initiator-instance_method" title="#add_host_initiator (instance method)">- (Object) <strong>add_host_initiator</strong>(host_id = nil, protocol = nil, initiator_port = nil, initiator_node = nil, auth = nil, cert = nil) </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
|
159
|
+
<p>Add an initiator to a host in ViPR.</p>
|
|
160
|
+
</div></span>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<li class="private ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#check_host_get-instance_method" title="#check_host_get (instance method)">- (Boolean) <strong>check_host_get</strong>(host_id) </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="note title private">private</span>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="summary_desc"><div class='inline'>
|
|
183
|
+
<p>Error Handling method to check for Missing Host ID param.</p>
|
|
184
|
+
</div></span>
|
|
185
|
+
|
|
186
|
+
</li>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<li class="private ">
|
|
190
|
+
<span class="summary_signature">
|
|
191
|
+
|
|
192
|
+
<a href="#check_host_post-instance_method" title="#check_host_post (instance method)">- (Boolean) <strong>check_host_post</strong>(host_type, ip_or_dns, name, user_name, password) </a>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</span>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="note title private">private</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<span class="summary_desc"><div class='inline'>
|
|
207
|
+
<p>Error Handling method to check for Missing Host Post params.</p>
|
|
208
|
+
</div></span>
|
|
209
|
+
|
|
210
|
+
</li>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<li class="private ">
|
|
214
|
+
<span class="summary_signature">
|
|
215
|
+
|
|
216
|
+
<a href="#check_host_post_initiator-instance_method" title="#check_host_post_initiator (instance method)">- (Boolean) <strong>check_host_post_initiator</strong>(protocol, initiator_port) </a>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
</span>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="note title private">private</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="summary_desc"><div class='inline'>
|
|
231
|
+
<p>Error Handling method to check for Initiator params.</p>
|
|
232
|
+
</div></span>
|
|
233
|
+
|
|
234
|
+
</li>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<li class="public ">
|
|
238
|
+
<span class="summary_signature">
|
|
239
|
+
|
|
240
|
+
<a href="#deactivate_host-instance_method" title="#deactivate_host (instance method)">- (JSON) <strong>deactivate_host</strong>(host_id = nil, auth = nil, cert = nil) </a>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</span>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<span class="summary_desc"><div class='inline'>
|
|
255
|
+
<p>Deactive and Remove a Host from ViPR.</p>
|
|
256
|
+
</div></span>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<li class="public ">
|
|
262
|
+
<span class="summary_signature">
|
|
263
|
+
|
|
264
|
+
<a href="#find_host_object-instance_method" title="#find_host_object (instance method)">- (JSON) <strong>find_host_object</strong>(search_param, auth = nil, cert = nil) </a>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
</span>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<span class="summary_desc"><div class='inline'>
|
|
279
|
+
<p>Find and return query results for a host in ViPR.</p>
|
|
280
|
+
</div></span>
|
|
281
|
+
|
|
282
|
+
</li>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<li class="public ">
|
|
286
|
+
<span class="summary_signature">
|
|
287
|
+
|
|
288
|
+
<a href="#generate_host_post_json-instance_method" title="#generate_host_post_json (instance method)">- (JSON) <strong>generate_host_post_json</strong>(host_type, ip_or_dns, name, port, user_name, password, use_ssl, discoverable) </a>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</span>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<span class="summary_desc"><div class='inline'>
|
|
303
|
+
<p>generate JSON for Host POST.</p>
|
|
304
|
+
</div></span>
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<li class="public ">
|
|
310
|
+
<span class="summary_signature">
|
|
311
|
+
|
|
312
|
+
<a href="#generate_initiators_json-instance_method" title="#generate_initiators_json (instance method)">- (ARRAY) <strong>generate_initiators_json</strong>(protocol, initiator_node, initiator_port) </a>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</span>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<span class="summary_desc"><div class='inline'>
|
|
327
|
+
<p>generate JSON for Initators POST.</p>
|
|
328
|
+
</div></span>
|
|
329
|
+
|
|
330
|
+
</li>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<li class="public ">
|
|
334
|
+
<span class="summary_signature">
|
|
335
|
+
|
|
336
|
+
<a href="#get_all_hosts-instance_method" title="#get_all_hosts (instance method)">- (JSON) <strong>get_all_hosts</strong>(auth = nil, cert = nil) </a>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</span>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<span class="summary_desc"><div class='inline'>
|
|
351
|
+
<p>Get all Host objects in ViPR.</p>
|
|
352
|
+
</div></span>
|
|
353
|
+
|
|
354
|
+
</li>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<li class="public ">
|
|
358
|
+
<span class="summary_signature">
|
|
359
|
+
|
|
360
|
+
<a href="#get_host-instance_method" title="#get_host (instance method)">- (Hash) <strong>get_host</strong>(host_id = nil, auth = nil, cert = nil) </a>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
</span>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
<span class="summary_desc"><div class='inline'>
|
|
375
|
+
<p>Get an individual host's details in ViPR.</p>
|
|
376
|
+
</div></span>
|
|
377
|
+
|
|
378
|
+
</li>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
<li class="public ">
|
|
382
|
+
<span class="summary_signature">
|
|
383
|
+
|
|
384
|
+
<a href="#host_exists%3F-instance_method" title="#host_exists? (instance method)">- (BOOLEAN) <strong>host_exists?</strong>(hostname, auth = nil, cert = nil) </a>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
</span>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
<span class="summary_desc"><div class='inline'>
|
|
399
|
+
<p>Determine if a host already exists in ViPR.</p>
|
|
400
|
+
</div></span>
|
|
401
|
+
|
|
402
|
+
</li>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
</ul>
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<div id="instance_method_details" class="method_details_list">
|
|
411
|
+
<h2>Instance Method Details</h2>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<div class="method_details first">
|
|
415
|
+
<h3 class="signature first" id="add_host-instance_method">
|
|
416
|
+
|
|
417
|
+
- (<tt>JSON</tt>) <strong>add_host</strong>(host_type = nil, ip_or_dns = nil, name = nil, user_name = nil, password = nil, port = nil, use_ssl = nil, discoverable = nil, auth = nil, cert = nil)
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</h3><div class="docstring">
|
|
424
|
+
<div class="discussion">
|
|
425
|
+
|
|
426
|
+
<p>Add a host to ViPR</p>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
</div>
|
|
430
|
+
</div>
|
|
431
|
+
<div class="tags">
|
|
432
|
+
|
|
433
|
+
<div class="examples">
|
|
434
|
+
<p class="tag_title">Examples:</p>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
<pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_host'>add_host</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Windows</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>windowshost.mydomain.org</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>WindowsHOST</span><span class='tstring_end'>'</span></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DOMAIN\user</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>userpw</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
438
|
+
<span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_host'>add_host</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Windows</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>windowshost.mydomain.org</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>WindowsHOST</span><span class='tstring_end'>'</span></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DOMAIN\user</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>userpw</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>453</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>true</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>true</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
439
|
+
<span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_host'>add_host</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Linux</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>linuxhost.mydomain.org</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>LinuxHOST</span><span class='tstring_end'>'</span></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DOMAIN\user</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>userpw</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
|
|
440
|
+
|
|
441
|
+
</div>
|
|
442
|
+
<p class="tag_title">Parameters:</p>
|
|
443
|
+
<ul class="param">
|
|
444
|
+
|
|
445
|
+
<li>
|
|
446
|
+
|
|
447
|
+
<span class='name'>host_type</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
—
|
|
457
|
+
<div class='inline'>
|
|
458
|
+
<p>Type of Host. “Windows”, “Linux”, or, “HPUX”. Required Param</p>
|
|
459
|
+
</div>
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
<li>
|
|
464
|
+
|
|
465
|
+
<span class='name'>ip_or_dns</span>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
—
|
|
475
|
+
<div class='inline'>
|
|
476
|
+
<p>IP Address or FQDN of host. Required Param</p>
|
|
477
|
+
</div>
|
|
478
|
+
|
|
479
|
+
</li>
|
|
480
|
+
|
|
481
|
+
<li>
|
|
482
|
+
|
|
483
|
+
<span class='name'>name</span>
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
—
|
|
493
|
+
<div class='inline'>
|
|
494
|
+
<p>Arbitrary Name only necesary and identifiable by ViPR. Required Param.</p>
|
|
495
|
+
</div>
|
|
496
|
+
|
|
497
|
+
</li>
|
|
498
|
+
|
|
499
|
+
<li>
|
|
500
|
+
|
|
501
|
+
<span class='name'>user_name</span>
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
—
|
|
511
|
+
<div class='inline'>
|
|
512
|
+
<p>User Name to connect to the host. Required Param</p>
|
|
513
|
+
</div>
|
|
514
|
+
|
|
515
|
+
</li>
|
|
516
|
+
|
|
517
|
+
<li>
|
|
518
|
+
|
|
519
|
+
<span class='name'>password</span>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
—
|
|
529
|
+
<div class='inline'>
|
|
530
|
+
<p>Password for the User Name to connect to the host. Required Param</p>
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
</li>
|
|
534
|
+
|
|
535
|
+
<li>
|
|
536
|
+
|
|
537
|
+
<span class='name'>port</span>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
—
|
|
547
|
+
<div class='inline'>
|
|
548
|
+
<p>Port to connect to the host. Optional Param. Defaults will be used if no
|
|
549
|
+
param is passed</p>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
</li>
|
|
553
|
+
|
|
554
|
+
<li>
|
|
555
|
+
|
|
556
|
+
<span class='name'>use_ssl</span>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
—
|
|
566
|
+
<div class='inline'>
|
|
567
|
+
<p>Whether SSL is used. Trur or False. Optional Param</p>
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
</li>
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
<span class='name'>discoverable</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>True or False. Initators and Nodes will be discovered after being added. By
|
|
586
|
+
default this is true</p>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
</li>
|
|
590
|
+
|
|
591
|
+
</ul>
|
|
592
|
+
|
|
593
|
+
<p class="tag_title">Returns:</p>
|
|
594
|
+
<ul class="return">
|
|
595
|
+
|
|
596
|
+
<li>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
—
|
|
604
|
+
<div class='inline'>
|
|
605
|
+
<p>returns host information</p>
|
|
606
|
+
</div>
|
|
607
|
+
|
|
608
|
+
</li>
|
|
609
|
+
|
|
610
|
+
</ul>
|
|
611
|
+
|
|
612
|
+
</div><table class="source_code">
|
|
613
|
+
<tr>
|
|
614
|
+
<td>
|
|
615
|
+
<pre class="lines">
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
71
|
|
619
|
+
72
|
|
620
|
+
73
|
|
621
|
+
74
|
|
622
|
+
75
|
|
623
|
+
76
|
|
624
|
+
77
|
|
625
|
+
78
|
|
626
|
+
79
|
|
627
|
+
80
|
|
628
|
+
81
|
|
629
|
+
82
|
|
630
|
+
83
|
|
631
|
+
84
|
|
632
|
+
85
|
|
633
|
+
86
|
|
634
|
+
87
|
|
635
|
+
88
|
|
636
|
+
89
|
|
637
|
+
90
|
|
638
|
+
91
|
|
639
|
+
92
|
|
640
|
+
93
|
|
641
|
+
94
|
|
642
|
+
95</pre>
|
|
643
|
+
</td>
|
|
644
|
+
<td>
|
|
645
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 71</span>
|
|
646
|
+
|
|
647
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_host'>add_host</span><span class='lparen'>(</span><span class='id identifier rubyid_host_type'>host_type</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_name'>name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_discoverable'>discoverable</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>
|
|
648
|
+
<span class='id identifier rubyid_check_host_post'>check_host_post</span><span class='lparen'>(</span><span class='id identifier rubyid_host_type'>host_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_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
|
|
649
|
+
<span class='id identifier rubyid_host_type'>host_type</span> <span class='op'>=</span> <span class='id identifier rubyid_host_type'>host_type</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:capitalize</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span>
|
|
650
|
+
|
|
651
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_host_type'>host_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Windows</span><span class='tstring_end'>"</span></span>
|
|
652
|
+
<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='id identifier rubyid_use_ssl'>use_ssl</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span>
|
|
653
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span> <span class='op'>==</span> <span class='kw'>true</span>
|
|
654
|
+
<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'>'</span><span class='tstring_content'>5986</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='id identifier rubyid_port'>port</span>
|
|
655
|
+
<span class='kw'>else</span>
|
|
656
|
+
<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'>'</span><span class='tstring_content'>5985</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='id identifier rubyid_port'>port</span>
|
|
657
|
+
<span class='kw'>end</span>
|
|
658
|
+
<span class='id identifier rubyid_discoverable'>discoverable</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_discoverable'>discoverable</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='id identifier rubyid_discoverable'>discoverable</span>
|
|
659
|
+
<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='id identifier rubyid_user_name'>user_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>admin</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_user_name'>user_name</span>
|
|
660
|
+
<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='id identifier rubyid_password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#1Password</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_password'>password</span>
|
|
661
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_host_type'>host_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Linux</span><span class='tstring_end'>"</span></span>
|
|
662
|
+
<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='id identifier rubyid_use_ssl'>use_ssl</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='op'>:</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span>
|
|
663
|
+
<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'>'</span><span class='tstring_content'>22</span><span class='tstring_end'>'</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>
|
|
664
|
+
<span class='id identifier rubyid_discoverable'>discoverable</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_discoverable'>discoverable</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='op'>:</span> <span class='id identifier rubyid_discoverable'>discoverable</span>
|
|
665
|
+
<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='id identifier rubyid_user_name'>user_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>admin</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_user_name'>user_name</span>
|
|
666
|
+
<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='id identifier rubyid_password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#1Password</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='id identifier rubyid_password'>password</span>
|
|
667
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_host_type'>host_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Hpux</span><span class='tstring_end'>"</span></span>
|
|
668
|
+
<span class='id identifier rubyid_host_type'>host_type</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>HPUX</span><span class='tstring_end'>"</span></span>
|
|
669
|
+
<span class='kw'>end</span>
|
|
670
|
+
<span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_generate_host_post_json'>generate_host_post_json</span><span class='lparen'>(</span><span class='id identifier rubyid_host_type'>host_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_name'>name</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='comma'>,</span> <span class='id identifier rubyid_discoverable'>discoverable</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/tenants/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@tenant_uid</span><span class='embexpr_end'>}</span><span class='tstring_content'>/hosts</span><span class='tstring_end'>"</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>
|
|
671
|
+
<span class='kw'>end</span></pre>
|
|
672
|
+
</td>
|
|
673
|
+
</tr>
|
|
674
|
+
</table>
|
|
675
|
+
</div>
|
|
676
|
+
|
|
677
|
+
<div class="method_details ">
|
|
678
|
+
<h3 class="signature " id="add_host_initiator-instance_method">
|
|
679
|
+
|
|
680
|
+
- (<tt>Object</tt>) <strong>add_host_initiator</strong>(host_id = nil, protocol = nil, initiator_port = nil, initiator_node = nil, auth = nil, cert = nil)
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
</h3><div class="docstring">
|
|
687
|
+
<div class="discussion">
|
|
688
|
+
|
|
689
|
+
<p>Add an initiator to a host in ViPR</p>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
</div>
|
|
693
|
+
</div>
|
|
694
|
+
<div class="tags">
|
|
695
|
+
|
|
696
|
+
<div class="examples">
|
|
697
|
+
<p class="tag_title">Examples:</p>
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
<pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_hosts'>get_all_hosts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
701
|
+
<span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_add_host_initiator'>add_host_initiator</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>FC</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>10:13:27:65:60:38:68:BE</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>10:13:27:65:60:38:68:BD</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>10:13:27:65:60:38:68:BC</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span></code></pre>
|
|
702
|
+
|
|
703
|
+
</div>
|
|
704
|
+
<p class="tag_title">Parameters:</p>
|
|
705
|
+
<ul class="param">
|
|
706
|
+
|
|
707
|
+
<li>
|
|
708
|
+
|
|
709
|
+
<span class='name'>host_id</span>
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
—
|
|
719
|
+
<div class='inline'>
|
|
720
|
+
<p>The Host UID. Required Param.</p>
|
|
721
|
+
</div>
|
|
722
|
+
|
|
723
|
+
</li>
|
|
724
|
+
|
|
725
|
+
<li>
|
|
726
|
+
|
|
727
|
+
<span class='name'>protocol</span>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
—
|
|
737
|
+
<div class='inline'>
|
|
738
|
+
<p>The protocol type. iSCSI or FC. Required</p>
|
|
739
|
+
</div>
|
|
740
|
+
|
|
741
|
+
</li>
|
|
742
|
+
|
|
743
|
+
<li>
|
|
744
|
+
|
|
745
|
+
<span class='name'>initiator_port</span>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
—
|
|
755
|
+
<div class='inline'>
|
|
756
|
+
<p>Initator Port as a string. Required</p>
|
|
757
|
+
</div>
|
|
758
|
+
|
|
759
|
+
</li>
|
|
760
|
+
|
|
761
|
+
<li>
|
|
762
|
+
|
|
763
|
+
<span class='name'>initiator_node</span>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
—
|
|
773
|
+
<div class='inline'>
|
|
774
|
+
<p>Initator Nodes must be passed in as strings in an array. Required.</p>
|
|
775
|
+
</div>
|
|
776
|
+
|
|
777
|
+
</li>
|
|
778
|
+
|
|
779
|
+
</ul>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
</div><table class="source_code">
|
|
783
|
+
<tr>
|
|
784
|
+
<td>
|
|
785
|
+
<pre class="lines">
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
107
|
|
789
|
+
108
|
|
790
|
+
109
|
|
791
|
+
110
|
|
792
|
+
111
|
|
793
|
+
112
|
|
794
|
+
113
|
|
795
|
+
114
|
|
796
|
+
115
|
|
797
|
+
116
|
|
798
|
+
117
|
|
799
|
+
118
|
|
800
|
+
119</pre>
|
|
801
|
+
</td>
|
|
802
|
+
<td>
|
|
803
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 107</span>
|
|
804
|
+
|
|
805
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_host_initiator'>add_host_initiator</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_protocol'>protocol</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_port'>initiator_port</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_node'>initiator_node</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>
|
|
806
|
+
<span class='id identifier rubyid_check_host_get'>check_host_get</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='rparen'>)</span>
|
|
807
|
+
<span class='id identifier rubyid_check_host_post_initiator'>check_host_post_initiator</span><span class='lparen'>(</span><span class='id identifier rubyid_protocol'>protocol</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_port'>initiator_port</span><span class='rparen'>)</span>
|
|
808
|
+
|
|
809
|
+
<span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>=</span> <span class='id identifier rubyid_protocol'>protocol</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span>
|
|
810
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ISCSI</span><span class='tstring_end'>"</span></span>
|
|
811
|
+
<span class='id identifier rubyid_protocol'>protocol</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>iSCSI</span><span class='tstring_end'>"</span></span>
|
|
812
|
+
<span class='kw'>end</span>
|
|
813
|
+
<span class='id identifier rubyid_initiator_payload_array'>initiator_payload_array</span> <span class='op'>=</span> <span class='id identifier rubyid_generate_initiators_json'>generate_initiators_json</span><span class='lparen'>(</span><span class='id identifier rubyid_protocol'>protocol</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_node'>initiator_node</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_port'>initiator_port</span><span class='rparen'>)</span>
|
|
814
|
+
<span class='id identifier rubyid_initiator_payload_array'>initiator_payload_array</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
|
|
815
|
+
<span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='id identifier rubyid_i'>i</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/compute/hosts/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_host_id'>host_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/initiators</span><span class='tstring_end'>"</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>
|
|
816
|
+
<span class='kw'>end</span>
|
|
817
|
+
<span class='kw'>end</span></pre>
|
|
818
|
+
</td>
|
|
819
|
+
</tr>
|
|
820
|
+
</table>
|
|
821
|
+
</div>
|
|
822
|
+
|
|
823
|
+
<div class="method_details ">
|
|
824
|
+
<h3 class="signature " id="check_host_get-instance_method">
|
|
825
|
+
|
|
826
|
+
- (<tt>Boolean</tt>) <strong>check_host_get</strong>(host_id) <span class="extras">(private)</span>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
</h3><div class="docstring">
|
|
833
|
+
<div class="discussion">
|
|
834
|
+
|
|
835
|
+
<p>Error Handling method to check for Missing Host ID param. If the pass
|
|
836
|
+
fails, an error exception is raised</p>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
</div>
|
|
840
|
+
</div>
|
|
841
|
+
<div class="tags">
|
|
842
|
+
<p class="tag_title">Parameters:</p>
|
|
843
|
+
<ul class="param">
|
|
844
|
+
|
|
845
|
+
<li>
|
|
846
|
+
|
|
847
|
+
<span class='name'>host_id</span>
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
—
|
|
855
|
+
<div class='inline'>
|
|
856
|
+
<p>Requires the string of the vcenter uid</p>
|
|
857
|
+
</div>
|
|
858
|
+
|
|
859
|
+
</li>
|
|
860
|
+
|
|
861
|
+
</ul>
|
|
862
|
+
|
|
863
|
+
<p class="tag_title">Returns:</p>
|
|
864
|
+
<ul class="return">
|
|
865
|
+
|
|
866
|
+
<li>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
—
|
|
874
|
+
<div class='inline'>
|
|
875
|
+
<p>True if pass, false if it fails</p>
|
|
876
|
+
</div>
|
|
877
|
+
|
|
878
|
+
</li>
|
|
879
|
+
|
|
880
|
+
</ul>
|
|
881
|
+
|
|
882
|
+
</div><table class="source_code">
|
|
883
|
+
<tr>
|
|
884
|
+
<td>
|
|
885
|
+
<pre class="lines">
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
215
|
|
889
|
+
216
|
|
890
|
+
217
|
|
891
|
+
218
|
|
892
|
+
219</pre>
|
|
893
|
+
</td>
|
|
894
|
+
<td>
|
|
895
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 215</span>
|
|
896
|
+
|
|
897
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_host_get'>check_host_get</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='rparen'>)</span>
|
|
898
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_host_id'>host_id</span> <span class='op'>==</span> <span class='kw'>nil</span>
|
|
899
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Missing the Required param (host_id). Find the host_id by using the get_all_hosts method.</span><span class='tstring_end'>"</span></span>
|
|
900
|
+
<span class='kw'>end</span>
|
|
901
|
+
<span class='kw'>end</span></pre>
|
|
902
|
+
</td>
|
|
903
|
+
</tr>
|
|
904
|
+
</table>
|
|
905
|
+
</div>
|
|
906
|
+
|
|
907
|
+
<div class="method_details ">
|
|
908
|
+
<h3 class="signature " id="check_host_post-instance_method">
|
|
909
|
+
|
|
910
|
+
- (<tt>Boolean</tt>) <strong>check_host_post</strong>(host_type, ip_or_dns, name, user_name, password) <span class="extras">(private)</span>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
</h3><div class="docstring">
|
|
917
|
+
<div class="discussion">
|
|
918
|
+
|
|
919
|
+
<p>Error Handling method to check for Missing Host Post params. If the pass
|
|
920
|
+
fails, an error exception is raised</p>
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
</div>
|
|
924
|
+
</div>
|
|
925
|
+
<div class="tags">
|
|
926
|
+
<p class="tag_title">Parameters:</p>
|
|
927
|
+
<ul class="param">
|
|
928
|
+
|
|
929
|
+
<li>
|
|
930
|
+
|
|
931
|
+
<span class='name'>host_type</span>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
—
|
|
939
|
+
<div class='inline'>
|
|
940
|
+
<p>Requires the string of the host type.</p>
|
|
941
|
+
</div>
|
|
942
|
+
|
|
943
|
+
</li>
|
|
944
|
+
|
|
945
|
+
<li>
|
|
946
|
+
|
|
947
|
+
<span class='name'>ip_or_dns</span>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
—
|
|
955
|
+
<div class='inline'>
|
|
956
|
+
<p>Requires the string of the IP Address or FQDN.</p>
|
|
957
|
+
</div>
|
|
958
|
+
|
|
959
|
+
</li>
|
|
960
|
+
|
|
961
|
+
<li>
|
|
962
|
+
|
|
963
|
+
<span class='name'>name</span>
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
—
|
|
971
|
+
<div class='inline'>
|
|
972
|
+
<p>Requires the string of the Arbitrary name for ViPR.</p>
|
|
973
|
+
</div>
|
|
974
|
+
|
|
975
|
+
</li>
|
|
976
|
+
|
|
977
|
+
<li>
|
|
978
|
+
|
|
979
|
+
<span class='name'>user_name</span>
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
—
|
|
987
|
+
<div class='inline'>
|
|
988
|
+
<p>Requires the string of the User Name for access.</p>
|
|
989
|
+
</div>
|
|
990
|
+
|
|
991
|
+
</li>
|
|
992
|
+
|
|
993
|
+
<li>
|
|
994
|
+
|
|
995
|
+
<span class='name'>password</span>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
—
|
|
1003
|
+
<div class='inline'>
|
|
1004
|
+
<p>Requires the string of the Password of the User Name for access</p>
|
|
1005
|
+
</div>
|
|
1006
|
+
|
|
1007
|
+
</li>
|
|
1008
|
+
|
|
1009
|
+
</ul>
|
|
1010
|
+
|
|
1011
|
+
<p class="tag_title">Returns:</p>
|
|
1012
|
+
<ul class="return">
|
|
1013
|
+
|
|
1014
|
+
<li>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
—
|
|
1022
|
+
<div class='inline'>
|
|
1023
|
+
<p>True if pass, false if it fails</p>
|
|
1024
|
+
</div>
|
|
1025
|
+
|
|
1026
|
+
</li>
|
|
1027
|
+
|
|
1028
|
+
</ul>
|
|
1029
|
+
|
|
1030
|
+
</div><table class="source_code">
|
|
1031
|
+
<tr>
|
|
1032
|
+
<td>
|
|
1033
|
+
<pre class="lines">
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
203
|
|
1037
|
+
204
|
|
1038
|
+
205
|
|
1039
|
+
206
|
|
1040
|
+
207</pre>
|
|
1041
|
+
</td>
|
|
1042
|
+
<td>
|
|
1043
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 203</span>
|
|
1044
|
+
|
|
1045
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_host_post'>check_host_post</span><span class='lparen'>(</span><span class='id identifier rubyid_host_type'>host_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_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
|
|
1046
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_host_type'>host_type</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> <span class='op'>||</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='kw'>nil</span>
|
|
1047
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Missing a Required param (host_type, ip_or_dns, name)</span><span class='tstring_end'>"</span></span>
|
|
1048
|
+
<span class='kw'>end</span>
|
|
1049
|
+
<span class='kw'>end</span></pre>
|
|
1050
|
+
</td>
|
|
1051
|
+
</tr>
|
|
1052
|
+
</table>
|
|
1053
|
+
</div>
|
|
1054
|
+
|
|
1055
|
+
<div class="method_details ">
|
|
1056
|
+
<h3 class="signature " id="check_host_post_initiator-instance_method">
|
|
1057
|
+
|
|
1058
|
+
- (<tt>Boolean</tt>) <strong>check_host_post_initiator</strong>(protocol, initiator_port) <span class="extras">(private)</span>
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
</h3><div class="docstring">
|
|
1065
|
+
<div class="discussion">
|
|
1066
|
+
|
|
1067
|
+
<p>Error Handling method to check for Initiator params. If the pass fails, an
|
|
1068
|
+
error exception is raised</p>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
</div>
|
|
1072
|
+
</div>
|
|
1073
|
+
<div class="tags">
|
|
1074
|
+
<p class="tag_title">Parameters:</p>
|
|
1075
|
+
<ul class="param">
|
|
1076
|
+
|
|
1077
|
+
<li>
|
|
1078
|
+
|
|
1079
|
+
<span class='name'>protocol</span>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
—
|
|
1087
|
+
<div class='inline'>
|
|
1088
|
+
<p>Requires the string of the Port</p>
|
|
1089
|
+
</div>
|
|
1090
|
+
|
|
1091
|
+
</li>
|
|
1092
|
+
|
|
1093
|
+
<li>
|
|
1094
|
+
|
|
1095
|
+
<span class='name'>initiator_port</span>
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
—
|
|
1103
|
+
<div class='inline'>
|
|
1104
|
+
<p>Requires the string of the initiator_port</p>
|
|
1105
|
+
</div>
|
|
1106
|
+
|
|
1107
|
+
</li>
|
|
1108
|
+
|
|
1109
|
+
</ul>
|
|
1110
|
+
|
|
1111
|
+
<p class="tag_title">Returns:</p>
|
|
1112
|
+
<ul class="return">
|
|
1113
|
+
|
|
1114
|
+
<li>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
—
|
|
1122
|
+
<div class='inline'>
|
|
1123
|
+
<p>True if pass, false if it fails</p>
|
|
1124
|
+
</div>
|
|
1125
|
+
|
|
1126
|
+
</li>
|
|
1127
|
+
|
|
1128
|
+
</ul>
|
|
1129
|
+
|
|
1130
|
+
</div><table class="source_code">
|
|
1131
|
+
<tr>
|
|
1132
|
+
<td>
|
|
1133
|
+
<pre class="lines">
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
228
|
|
1137
|
+
229
|
|
1138
|
+
230
|
|
1139
|
+
231
|
|
1140
|
+
232</pre>
|
|
1141
|
+
</td>
|
|
1142
|
+
<td>
|
|
1143
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 228</span>
|
|
1144
|
+
|
|
1145
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_check_host_post_initiator'>check_host_post_initiator</span><span class='lparen'>(</span><span class='id identifier rubyid_protocol'>protocol</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_port'>initiator_port</span><span class='rparen'>)</span>
|
|
1146
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_protocol'>protocol</span><span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id identifier rubyid_initiator_port'>initiator_port</span> <span class='op'>==</span> <span class='kw'>nil</span>
|
|
1147
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Missing the Required param (protocol or initiator_port).</span><span class='tstring_end'>"</span></span>
|
|
1148
|
+
<span class='kw'>end</span>
|
|
1149
|
+
<span class='kw'>end</span></pre>
|
|
1150
|
+
</td>
|
|
1151
|
+
</tr>
|
|
1152
|
+
</table>
|
|
1153
|
+
</div>
|
|
1154
|
+
|
|
1155
|
+
<div class="method_details ">
|
|
1156
|
+
<h3 class="signature " id="deactivate_host-instance_method">
|
|
1157
|
+
|
|
1158
|
+
- (<tt>JSON</tt>) <strong>deactivate_host</strong>(host_id = nil, auth = nil, cert = nil)
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
</h3><div class="docstring">
|
|
1165
|
+
<div class="discussion">
|
|
1166
|
+
|
|
1167
|
+
<p>Deactive and Remove a Host from ViPR</p>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
</div>
|
|
1171
|
+
</div>
|
|
1172
|
+
<div class="tags">
|
|
1173
|
+
|
|
1174
|
+
<div class="examples">
|
|
1175
|
+
<p class="tag_title">Examples:</p>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
<pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_hosts'>get_all_hosts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
1179
|
+
<span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_deactivate_host'>deactivate_host</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
|
|
1180
|
+
|
|
1181
|
+
</div>
|
|
1182
|
+
<p class="tag_title">Parameters:</p>
|
|
1183
|
+
<ul class="param">
|
|
1184
|
+
|
|
1185
|
+
<li>
|
|
1186
|
+
|
|
1187
|
+
<span class='name'>host_id</span>
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
<span class='type'>(<tt>STRING</tt>)</span>
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
—
|
|
1197
|
+
<div class='inline'>
|
|
1198
|
+
<p>ID of host to get information. Required Param</p>
|
|
1199
|
+
</div>
|
|
1200
|
+
|
|
1201
|
+
</li>
|
|
1202
|
+
|
|
1203
|
+
</ul>
|
|
1204
|
+
|
|
1205
|
+
<p class="tag_title">Returns:</p>
|
|
1206
|
+
<ul class="return">
|
|
1207
|
+
|
|
1208
|
+
<li>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
—
|
|
1216
|
+
<div class='inline'>
|
|
1217
|
+
<p>returns information from POST for removing Host object</p>
|
|
1218
|
+
</div>
|
|
1219
|
+
|
|
1220
|
+
</li>
|
|
1221
|
+
|
|
1222
|
+
</ul>
|
|
1223
|
+
|
|
1224
|
+
</div><table class="source_code">
|
|
1225
|
+
<tr>
|
|
1226
|
+
<td>
|
|
1227
|
+
<pre class="lines">
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
154
|
|
1231
|
+
155
|
|
1232
|
+
156
|
|
1233
|
+
157</pre>
|
|
1234
|
+
</td>
|
|
1235
|
+
<td>
|
|
1236
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 154</span>
|
|
1237
|
+
|
|
1238
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_deactivate_host'>deactivate_host</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1239
|
+
<span class='id identifier rubyid_check_host_get'>check_host_get</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='rparen'>)</span>
|
|
1240
|
+
<span class='id identifier rubyid_rest_post'>rest_post</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/compute/hosts/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_host_id'>host_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deactivate</span><span class='tstring_end'>"</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>
|
|
1241
|
+
<span class='kw'>end</span></pre>
|
|
1242
|
+
</td>
|
|
1243
|
+
</tr>
|
|
1244
|
+
</table>
|
|
1245
|
+
</div>
|
|
1246
|
+
|
|
1247
|
+
<div class="method_details ">
|
|
1248
|
+
<h3 class="signature " id="find_host_object-instance_method">
|
|
1249
|
+
|
|
1250
|
+
- (<tt>JSON</tt>) <strong>find_host_object</strong>(search_param, auth = nil, cert = nil)
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
</h3><div class="docstring">
|
|
1257
|
+
<div class="discussion">
|
|
1258
|
+
|
|
1259
|
+
<p>Find and return query results for a host in ViPR</p>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
</div>
|
|
1263
|
+
</div>
|
|
1264
|
+
<div class="tags">
|
|
1265
|
+
|
|
1266
|
+
<div class="examples">
|
|
1267
|
+
<p class="tag_title">Examples:</p>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_find_host_object'>find_host_object</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>host1</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
|
|
1271
|
+
|
|
1272
|
+
</div>
|
|
1273
|
+
<p class="tag_title">Parameters:</p>
|
|
1274
|
+
<ul class="param">
|
|
1275
|
+
|
|
1276
|
+
<li>
|
|
1277
|
+
|
|
1278
|
+
<span class='name'>search_param</span>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
<span class='type'>(<tt>STRING</tt>)</span>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
—
|
|
1286
|
+
<div class='inline'>
|
|
1287
|
+
<p>Value to search host for. This will work with partials</p>
|
|
1288
|
+
</div>
|
|
1289
|
+
|
|
1290
|
+
</li>
|
|
1291
|
+
|
|
1292
|
+
</ul>
|
|
1293
|
+
|
|
1294
|
+
<p class="tag_title">Returns:</p>
|
|
1295
|
+
<ul class="return">
|
|
1296
|
+
|
|
1297
|
+
<li>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
—
|
|
1305
|
+
<div class='inline'>
|
|
1306
|
+
<p>returns search results</p>
|
|
1307
|
+
</div>
|
|
1308
|
+
|
|
1309
|
+
</li>
|
|
1310
|
+
|
|
1311
|
+
</ul>
|
|
1312
|
+
|
|
1313
|
+
</div><table class="source_code">
|
|
1314
|
+
<tr>
|
|
1315
|
+
<td>
|
|
1316
|
+
<pre class="lines">
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
187
|
|
1320
|
+
188
|
|
1321
|
+
189</pre>
|
|
1322
|
+
</td>
|
|
1323
|
+
<td>
|
|
1324
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 187</span>
|
|
1325
|
+
|
|
1326
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_find_host_object'>find_host_object</span><span class='lparen'>(</span><span class='id identifier rubyid_search_param'>search_param</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>
|
|
1327
|
+
<span class='id identifier rubyid_rest_get'>rest_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/compute/hosts/search?name=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search_param'>search_param</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</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>
|
|
1328
|
+
<span class='kw'>end</span></pre>
|
|
1329
|
+
</td>
|
|
1330
|
+
</tr>
|
|
1331
|
+
</table>
|
|
1332
|
+
</div>
|
|
1333
|
+
|
|
1334
|
+
<div class="method_details ">
|
|
1335
|
+
<h3 class="signature " id="generate_host_post_json-instance_method">
|
|
1336
|
+
|
|
1337
|
+
- (<tt>JSON</tt>) <strong>generate_host_post_json</strong>(host_type, ip_or_dns, name, port, user_name, password, use_ssl, discoverable)
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
</h3><div class="docstring">
|
|
1344
|
+
<div class="discussion">
|
|
1345
|
+
|
|
1346
|
+
<p>generate JSON for Host POST</p>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
</div>
|
|
1350
|
+
</div>
|
|
1351
|
+
<div class="tags">
|
|
1352
|
+
<p class="tag_title">Parameters:</p>
|
|
1353
|
+
<ul class="param">
|
|
1354
|
+
|
|
1355
|
+
<li>
|
|
1356
|
+
|
|
1357
|
+
<span class='name'>host_type</span>
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
—
|
|
1365
|
+
<div class='inline'>
|
|
1366
|
+
<p>Type of Host. Required Param.</p>
|
|
1367
|
+
</div>
|
|
1368
|
+
|
|
1369
|
+
</li>
|
|
1370
|
+
|
|
1371
|
+
<li>
|
|
1372
|
+
|
|
1373
|
+
<span class='name'>ip_or_dns</span>
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
—
|
|
1381
|
+
<div class='inline'>
|
|
1382
|
+
<p>IP Address or FQDN of the host to add. Required Param.</p>
|
|
1383
|
+
</div>
|
|
1384
|
+
|
|
1385
|
+
</li>
|
|
1386
|
+
|
|
1387
|
+
<li>
|
|
1388
|
+
|
|
1389
|
+
<span class='name'>name</span>
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
—
|
|
1397
|
+
<div class='inline'>
|
|
1398
|
+
<p>Arbitrary name given to the host. Required Param</p>
|
|
1399
|
+
</div>
|
|
1400
|
+
|
|
1401
|
+
</li>
|
|
1402
|
+
|
|
1403
|
+
<li>
|
|
1404
|
+
|
|
1405
|
+
<span class='name'>port</span>
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
—
|
|
1413
|
+
<div class='inline'>
|
|
1414
|
+
<p>Port for connecting to the specfic host. Will be autogenerated if not
|
|
1415
|
+
specified by the <span class='object_link'><a href="#add_host-instance_method" title="ViprHost#add_host (method)">#add_host</a></span> method</p>
|
|
1416
|
+
</div>
|
|
1417
|
+
|
|
1418
|
+
</li>
|
|
1419
|
+
|
|
1420
|
+
<li>
|
|
1421
|
+
|
|
1422
|
+
<span class='name'>user_name</span>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
—
|
|
1430
|
+
<div class='inline'>
|
|
1431
|
+
<p>User Name to connect to this host.</p>
|
|
1432
|
+
</div>
|
|
1433
|
+
|
|
1434
|
+
</li>
|
|
1435
|
+
|
|
1436
|
+
<li>
|
|
1437
|
+
|
|
1438
|
+
<span class='name'>password</span>
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
—
|
|
1446
|
+
<div class='inline'>
|
|
1447
|
+
<p>Password for the Username to connect to this host.</p>
|
|
1448
|
+
</div>
|
|
1449
|
+
|
|
1450
|
+
</li>
|
|
1451
|
+
|
|
1452
|
+
<li>
|
|
1453
|
+
|
|
1454
|
+
<span class='name'>use_ssl</span>
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
—
|
|
1462
|
+
<div class='inline'>
|
|
1463
|
+
<p>True or False</p>
|
|
1464
|
+
</div>
|
|
1465
|
+
|
|
1466
|
+
</li>
|
|
1467
|
+
|
|
1468
|
+
<li>
|
|
1469
|
+
|
|
1470
|
+
<span class='name'>discoverable</span>
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
—
|
|
1478
|
+
<div class='inline'>
|
|
1479
|
+
<p>True or False for searching initators after being added.</p>
|
|
1480
|
+
</div>
|
|
1481
|
+
|
|
1482
|
+
</li>
|
|
1483
|
+
|
|
1484
|
+
</ul>
|
|
1485
|
+
|
|
1486
|
+
<p class="tag_title">Returns:</p>
|
|
1487
|
+
<ul class="return">
|
|
1488
|
+
|
|
1489
|
+
<li>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
—
|
|
1497
|
+
<div class='inline'>
|
|
1498
|
+
<p>The JSON object for the POST operation</p>
|
|
1499
|
+
</div>
|
|
1500
|
+
|
|
1501
|
+
</li>
|
|
1502
|
+
|
|
1503
|
+
</ul>
|
|
1504
|
+
|
|
1505
|
+
</div><table class="source_code">
|
|
1506
|
+
<tr>
|
|
1507
|
+
<td>
|
|
1508
|
+
<pre class="lines">
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
19
|
|
1512
|
+
20
|
|
1513
|
+
21
|
|
1514
|
+
22
|
|
1515
|
+
23
|
|
1516
|
+
24
|
|
1517
|
+
25
|
|
1518
|
+
26
|
|
1519
|
+
27
|
|
1520
|
+
28
|
|
1521
|
+
29
|
|
1522
|
+
30
|
|
1523
|
+
31
|
|
1524
|
+
32</pre>
|
|
1525
|
+
</td>
|
|
1526
|
+
<td>
|
|
1527
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 19</span>
|
|
1528
|
+
|
|
1529
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_generate_host_post_json'>generate_host_post_json</span><span class='lparen'>(</span><span class='id identifier rubyid_host_type'>host_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_name'>name</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='comma'>,</span> <span class='id identifier rubyid_discoverable'>discoverable</span><span class='rparen'>)</span>
|
|
1530
|
+
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1531
|
+
<span class='label'>type:</span> <span class='id identifier rubyid_host_type'>host_type</span><span class='comma'>,</span>
|
|
1532
|
+
<span class='label'>host_name:</span> <span class='id identifier rubyid_ip_or_dns'>ip_or_dns</span><span class='comma'>,</span>
|
|
1533
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
|
1534
|
+
<span class='label'>port_number:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span>
|
|
1535
|
+
<span class='label'>user_name:</span> <span class='id identifier rubyid_user_name'>user_name</span><span class='comma'>,</span>
|
|
1536
|
+
<span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
|
|
1537
|
+
<span class='label'>use_ssl:</span> <span class='id identifier rubyid_use_ssl'>use_ssl</span><span class='comma'>,</span>
|
|
1538
|
+
<span class='label'>discoverable:</span> <span class='id identifier rubyid_discoverable'>discoverable</span>
|
|
1539
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
|
1540
|
+
|
|
1541
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_payload'>payload</span>
|
|
1542
|
+
<span class='kw'>end</span></pre>
|
|
1543
|
+
</td>
|
|
1544
|
+
</tr>
|
|
1545
|
+
</table>
|
|
1546
|
+
</div>
|
|
1547
|
+
|
|
1548
|
+
<div class="method_details ">
|
|
1549
|
+
<h3 class="signature " id="generate_initiators_json-instance_method">
|
|
1550
|
+
|
|
1551
|
+
- (<tt>ARRAY</tt>) <strong>generate_initiators_json</strong>(protocol, initiator_node, initiator_port)
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
</h3><div class="docstring">
|
|
1558
|
+
<div class="discussion">
|
|
1559
|
+
|
|
1560
|
+
<p>generate JSON for Initators POST</p>
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
</div>
|
|
1564
|
+
</div>
|
|
1565
|
+
<div class="tags">
|
|
1566
|
+
<p class="tag_title">Parameters:</p>
|
|
1567
|
+
<ul class="param">
|
|
1568
|
+
|
|
1569
|
+
<li>
|
|
1570
|
+
|
|
1571
|
+
<span class='name'>protocol</span>
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
—
|
|
1579
|
+
<div class='inline'>
|
|
1580
|
+
<p>Type of protocol. Required Param</p>
|
|
1581
|
+
</div>
|
|
1582
|
+
|
|
1583
|
+
</li>
|
|
1584
|
+
|
|
1585
|
+
<li>
|
|
1586
|
+
|
|
1587
|
+
<span class='name'>initiator_node</span>
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
—
|
|
1595
|
+
<div class='inline'>
|
|
1596
|
+
<p>Node string. Required Param</p>
|
|
1597
|
+
</div>
|
|
1598
|
+
|
|
1599
|
+
</li>
|
|
1600
|
+
|
|
1601
|
+
<li>
|
|
1602
|
+
|
|
1603
|
+
<span class='name'>initiator_port</span>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
—
|
|
1611
|
+
<div class='inline'>
|
|
1612
|
+
<p>Ports should be passed as an array. Every port will be added into another
|
|
1613
|
+
array for the entire JSON object</p>
|
|
1614
|
+
</div>
|
|
1615
|
+
|
|
1616
|
+
</li>
|
|
1617
|
+
|
|
1618
|
+
</ul>
|
|
1619
|
+
|
|
1620
|
+
<p class="tag_title">Returns:</p>
|
|
1621
|
+
<ul class="return">
|
|
1622
|
+
|
|
1623
|
+
<li>
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
<span class='type'>(<tt>ARRAY</tt>)</span>
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
—
|
|
1631
|
+
<div class='inline'>
|
|
1632
|
+
<p>JSON objects will be put into an Array</p>
|
|
1633
|
+
</div>
|
|
1634
|
+
|
|
1635
|
+
</li>
|
|
1636
|
+
|
|
1637
|
+
</ul>
|
|
1638
|
+
|
|
1639
|
+
</div><table class="source_code">
|
|
1640
|
+
<tr>
|
|
1641
|
+
<td>
|
|
1642
|
+
<pre class="lines">
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
41
|
|
1646
|
+
42
|
|
1647
|
+
43
|
|
1648
|
+
44
|
|
1649
|
+
45
|
|
1650
|
+
46
|
|
1651
|
+
47
|
|
1652
|
+
48
|
|
1653
|
+
49
|
|
1654
|
+
50
|
|
1655
|
+
51
|
|
1656
|
+
52</pre>
|
|
1657
|
+
</td>
|
|
1658
|
+
<td>
|
|
1659
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 41</span>
|
|
1660
|
+
|
|
1661
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_generate_initiators_json'>generate_initiators_json</span><span class='lparen'>(</span><span class='id identifier rubyid_protocol'>protocol</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_node'>initiator_node</span><span class='comma'>,</span> <span class='id identifier rubyid_initiator_port'>initiator_port</span><span class='rparen'>)</span>
|
|
1662
|
+
<span class='id identifier rubyid_initiator_json'>initiator_json</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
1663
|
+
<span class='id identifier rubyid_initiator_port'>initiator_port</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_initiator'>initiator</span><span class='op'>|</span>
|
|
1664
|
+
<span class='id identifier rubyid_initiator_json'>initiator_json</span> <span class='op'><<</span>
|
|
1665
|
+
<span class='lbrace'>{</span>
|
|
1666
|
+
<span class='label'>protocol:</span> <span class='id identifier rubyid_protocol'>protocol</span><span class='comma'>,</span>
|
|
1667
|
+
<span class='label'>initiator_node:</span> <span class='id identifier rubyid_initiator_node'>initiator_node</span><span class='comma'>,</span>
|
|
1668
|
+
<span class='label'>initiator_port:</span> <span class='id identifier rubyid_initiator'>initiator</span>
|
|
1669
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
|
1670
|
+
<span class='kw'>end</span>
|
|
1671
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_initiator_json'>initiator_json</span>
|
|
1672
|
+
<span class='kw'>end</span></pre>
|
|
1673
|
+
</td>
|
|
1674
|
+
</tr>
|
|
1675
|
+
</table>
|
|
1676
|
+
</div>
|
|
1677
|
+
|
|
1678
|
+
<div class="method_details ">
|
|
1679
|
+
<h3 class="signature " id="get_all_hosts-instance_method">
|
|
1680
|
+
|
|
1681
|
+
- (<tt>JSON</tt>) <strong>get_all_hosts</strong>(auth = nil, cert = nil)
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
</h3><div class="docstring">
|
|
1688
|
+
<div class="discussion">
|
|
1689
|
+
|
|
1690
|
+
<p>Get all Host objects in ViPR</p>
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
</div>
|
|
1694
|
+
</div>
|
|
1695
|
+
<div class="tags">
|
|
1696
|
+
|
|
1697
|
+
<div class="examples">
|
|
1698
|
+
<p class="tag_title">Examples:</p>
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
<pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_hosts'>get_all_hosts</span></code></pre>
|
|
1702
|
+
|
|
1703
|
+
</div>
|
|
1704
|
+
|
|
1705
|
+
<p class="tag_title">Returns:</p>
|
|
1706
|
+
<ul class="return">
|
|
1707
|
+
|
|
1708
|
+
<li>
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
—
|
|
1716
|
+
<div class='inline'>
|
|
1717
|
+
<p>returns a JSON collection of all hosts in ViPR for a particular tenant</p>
|
|
1718
|
+
</div>
|
|
1719
|
+
|
|
1720
|
+
</li>
|
|
1721
|
+
|
|
1722
|
+
</ul>
|
|
1723
|
+
|
|
1724
|
+
</div><table class="source_code">
|
|
1725
|
+
<tr>
|
|
1726
|
+
<td>
|
|
1727
|
+
<pre class="lines">
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
127
|
|
1731
|
+
128
|
|
1732
|
+
129</pre>
|
|
1733
|
+
</td>
|
|
1734
|
+
<td>
|
|
1735
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 127</span>
|
|
1736
|
+
|
|
1737
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_all_hosts'>get_all_hosts</span><span class='lparen'>(</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1738
|
+
<span class='id identifier rubyid_rest_get'>rest_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/tenants/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@tenant_uid</span><span class='embexpr_end'>}</span><span class='tstring_content'>/hosts</span><span class='tstring_end'>"</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>
|
|
1739
|
+
<span class='kw'>end</span></pre>
|
|
1740
|
+
</td>
|
|
1741
|
+
</tr>
|
|
1742
|
+
</table>
|
|
1743
|
+
</div>
|
|
1744
|
+
|
|
1745
|
+
<div class="method_details ">
|
|
1746
|
+
<h3 class="signature " id="get_host-instance_method">
|
|
1747
|
+
|
|
1748
|
+
- (<tt>Hash</tt>) <strong>get_host</strong>(host_id = nil, auth = nil, cert = nil)
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
</h3><div class="docstring">
|
|
1755
|
+
<div class="discussion">
|
|
1756
|
+
|
|
1757
|
+
<p>Get an individual host's details in ViPR</p>
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
</div>
|
|
1761
|
+
</div>
|
|
1762
|
+
<div class="tags">
|
|
1763
|
+
|
|
1764
|
+
<div class="examples">
|
|
1765
|
+
<p class="tag_title">Examples:</p>
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
<pre class="example code"><code><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_all_hosts'>get_all_hosts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
1769
|
+
<span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_get_host'>get_host</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span></code></pre>
|
|
1770
|
+
|
|
1771
|
+
</div>
|
|
1772
|
+
<p class="tag_title">Parameters:</p>
|
|
1773
|
+
<ul class="param">
|
|
1774
|
+
|
|
1775
|
+
<li>
|
|
1776
|
+
|
|
1777
|
+
<span class='name'>host_id</span>
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
<span class='type'>(<tt>STRING</tt>)</span>
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
—
|
|
1787
|
+
<div class='inline'>
|
|
1788
|
+
<p>ID of host to get information. Required Param</p>
|
|
1789
|
+
</div>
|
|
1790
|
+
|
|
1791
|
+
</li>
|
|
1792
|
+
|
|
1793
|
+
</ul>
|
|
1794
|
+
|
|
1795
|
+
<p class="tag_title">Returns:</p>
|
|
1796
|
+
<ul class="return">
|
|
1797
|
+
|
|
1798
|
+
<li>
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
—
|
|
1806
|
+
<div class='inline'>
|
|
1807
|
+
<p>the object converted into Hash format and can be parsed with <a
|
|
1808
|
+
href="0">object</a> or <a href="'id'">object</a> notation</p>
|
|
1809
|
+
</div>
|
|
1810
|
+
|
|
1811
|
+
</li>
|
|
1812
|
+
|
|
1813
|
+
</ul>
|
|
1814
|
+
|
|
1815
|
+
</div><table class="source_code">
|
|
1816
|
+
<tr>
|
|
1817
|
+
<td>
|
|
1818
|
+
<pre class="lines">
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
140
|
|
1822
|
+
141
|
|
1823
|
+
142
|
|
1824
|
+
143</pre>
|
|
1825
|
+
</td>
|
|
1826
|
+
<td>
|
|
1827
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 140</span>
|
|
1828
|
+
|
|
1829
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_host'>get_host</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1830
|
+
<span class='id identifier rubyid_check_host_get'>check_host_get</span><span class='lparen'>(</span><span class='id identifier rubyid_host_id'>host_id</span><span class='rparen'>)</span>
|
|
1831
|
+
<span class='id identifier rubyid_rest_get'>rest_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@base_url</span><span class='embexpr_end'>}</span><span class='tstring_content'>/compute/hosts/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_host_id'>host_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</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>
|
|
1832
|
+
<span class='kw'>end</span></pre>
|
|
1833
|
+
</td>
|
|
1834
|
+
</tr>
|
|
1835
|
+
</table>
|
|
1836
|
+
</div>
|
|
1837
|
+
|
|
1838
|
+
<div class="method_details ">
|
|
1839
|
+
<h3 class="signature " id="host_exists?-instance_method">
|
|
1840
|
+
|
|
1841
|
+
- (<tt>BOOLEAN</tt>) <strong>host_exists?</strong>(hostname, auth = nil, cert = nil)
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
</h3><div class="docstring">
|
|
1848
|
+
<div class="discussion">
|
|
1849
|
+
|
|
1850
|
+
<p>Determine if a host already exists in ViPR</p>
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
</div>
|
|
1854
|
+
</div>
|
|
1855
|
+
<div class="tags">
|
|
1856
|
+
|
|
1857
|
+
<div class="examples">
|
|
1858
|
+
<p class="tag_title">Examples:</p>
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
<pre class="example code"><code><span class='id identifier rubyid_vipr'>vipr</span><span class='period'>.</span><span class='id identifier rubyid_host_exists?'>host_exists?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>windowslab.mydomain.com</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
|
|
1862
|
+
|
|
1863
|
+
</div>
|
|
1864
|
+
<p class="tag_title">Parameters:</p>
|
|
1865
|
+
<ul class="param">
|
|
1866
|
+
|
|
1867
|
+
<li>
|
|
1868
|
+
|
|
1869
|
+
<span class='name'>hostname</span>
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
<span class='type'>(<tt>STRING</tt>)</span>
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
—
|
|
1877
|
+
<div class='inline'>
|
|
1878
|
+
<p>The name of the host to search for. Requires full name and not partials</p>
|
|
1879
|
+
</div>
|
|
1880
|
+
|
|
1881
|
+
</li>
|
|
1882
|
+
|
|
1883
|
+
</ul>
|
|
1884
|
+
|
|
1885
|
+
<p class="tag_title">Returns:</p>
|
|
1886
|
+
<ul class="return">
|
|
1887
|
+
|
|
1888
|
+
<li>
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
<span class='type'>(<tt>BOOLEAN</tt>)</span>
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
—
|
|
1896
|
+
<div class='inline'>
|
|
1897
|
+
<p>returns TRUE/FALSE</p>
|
|
1898
|
+
</div>
|
|
1899
|
+
|
|
1900
|
+
</li>
|
|
1901
|
+
|
|
1902
|
+
</ul>
|
|
1903
|
+
|
|
1904
|
+
</div><table class="source_code">
|
|
1905
|
+
<tr>
|
|
1906
|
+
<td>
|
|
1907
|
+
<pre class="lines">
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
167
|
|
1911
|
+
168
|
|
1912
|
+
169
|
|
1913
|
+
170
|
|
1914
|
+
171
|
|
1915
|
+
172
|
|
1916
|
+
173
|
|
1917
|
+
174
|
|
1918
|
+
175
|
|
1919
|
+
176
|
|
1920
|
+
177</pre>
|
|
1921
|
+
</td>
|
|
1922
|
+
<td>
|
|
1923
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/host.rb', line 167</span>
|
|
1924
|
+
|
|
1925
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_host_exists?'>host_exists?</span><span class='lparen'>(</span><span class='id identifier rubyid_hostname'>hostname</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>
|
|
1926
|
+
<span class='id identifier rubyid_hostname'>hostname</span> <span class='op'>=</span> <span class='id identifier rubyid_hostname'>hostname</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
|
1927
|
+
<span class='id identifier rubyid_host_array'>host_array</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
1928
|
+
<span class='id identifier rubyid_hosts'>hosts</span> <span class='op'>=</span> <span class='id identifier rubyid_get_all_hosts'>get_all_hosts</span>
|
|
1929
|
+
<span class='id identifier rubyid_hosts'>hosts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
1930
|
+
<span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span>
|
|
1931
|
+
<span class='id identifier rubyid_host_array'>host_array</span> <span class='op'><<</span> <span class='id identifier rubyid_k'>k</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
|
1932
|
+
<span class='kw'>end</span>
|
|
1933
|
+
<span class='kw'>end</span>
|
|
1934
|
+
<span class='id identifier rubyid_host_array'>host_array</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_hostname'>hostname</span><span class='rparen'>)</span>
|
|
1935
|
+
<span class='kw'>end</span></pre>
|
|
1936
|
+
</td>
|
|
1937
|
+
</tr>
|
|
1938
|
+
</table>
|
|
1939
|
+
</div>
|
|
1940
|
+
|
|
1941
|
+
</div>
|
|
1942
|
+
|
|
1943
|
+
</div>
|
|
1944
|
+
|
|
1945
|
+
<div id="footer">
|
|
1946
|
+
Generated on Mon Dec 15 13:52:44 2014 by
|
|
1947
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1948
|
+
0.8.7.6 (ruby-2.1.2).
|
|
1949
|
+
</div>
|
|
1950
|
+
|
|
1951
|
+
</body>
|
|
1952
|
+
</html>
|