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.
- 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/Vipr.html
ADDED
@@ -0,0 +1,656 @@
|
|
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
|
+
Class: Vipr
|
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#!Vipr.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">Vipr</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>Class: Vipr
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Object</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">Vipr</li>
|
82
|
+
|
83
|
+
</ul>
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
85
|
+
|
86
|
+
</dd>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
<dt class="r2">Includes:</dt>
|
94
|
+
<dd class="r2"><span class='object_link'><a href="ViprBase.html" title="ViprBase (module)">ViprBase</a></span>, <span class='object_link'><a href="ViprHost.html" title="ViprHost (module)">ViprHost</a></span>, <span class='object_link'><a href="ViprStorageSystem.html" title="ViprStorageSystem (module)">ViprStorageSystem</a></span>, <span class='object_link'><a href="ViprVcenter.html" title="ViprVcenter (module)">ViprVcenter</a></span></dd>
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
<dt class="r1 last">Defined in:</dt>
|
101
|
+
<dd class="r1 last">lib/vipruby/vipr.rb</dd>
|
102
|
+
|
103
|
+
</dl>
|
104
|
+
<div class="clear"></div>
|
105
|
+
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
107
|
+
<div class="discussion">
|
108
|
+
|
109
|
+
<p>The base class for the gem. Every subsequent method relies on creating an
|
110
|
+
object from this class</p>
|
111
|
+
|
112
|
+
|
113
|
+
</div>
|
114
|
+
</div>
|
115
|
+
<div class="tags">
|
116
|
+
|
117
|
+
|
118
|
+
</div>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
123
|
+
<ul class="summary">
|
124
|
+
|
125
|
+
<li class="public ">
|
126
|
+
<span class="summary_signature">
|
127
|
+
|
128
|
+
<a href="#auth_token-instance_method" title="#auth_token (instance method)">- (Object) <strong>auth_token</strong> </a>
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
</span>
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
<span class="summary_desc"><div class='inline'>
|
146
|
+
<p>required params used for almost every single method.</p>
|
147
|
+
</div></span>
|
148
|
+
|
149
|
+
</li>
|
150
|
+
|
151
|
+
|
152
|
+
<li class="public ">
|
153
|
+
<span class="summary_signature">
|
154
|
+
|
155
|
+
<a href="#base_url-instance_method" title="#base_url (instance method)">- (Object) <strong>base_url</strong> </a>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
</span>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
<span class="summary_desc"><div class='inline'>
|
173
|
+
<p>required params used for almost every single method.</p>
|
174
|
+
</div></span>
|
175
|
+
|
176
|
+
</li>
|
177
|
+
|
178
|
+
|
179
|
+
<li class="public ">
|
180
|
+
<span class="summary_signature">
|
181
|
+
|
182
|
+
<a href="#tenant_uid-instance_method" title="#tenant_uid (instance method)">- (Object) <strong>tenant_uid</strong> </a>
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
</span>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
<span class="summary_desc"><div class='inline'>
|
200
|
+
<p>required params used for almost every single method.</p>
|
201
|
+
</div></span>
|
202
|
+
|
203
|
+
</li>
|
204
|
+
|
205
|
+
|
206
|
+
<li class="public ">
|
207
|
+
<span class="summary_signature">
|
208
|
+
|
209
|
+
<a href="#verify_cert-instance_method" title="#verify_cert (instance method)">- (Object) <strong>verify_cert</strong> </a>
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
</span>
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
<span class="summary_desc"><div class='inline'>
|
227
|
+
<p>required params used for almost every single method.</p>
|
228
|
+
</div></span>
|
229
|
+
|
230
|
+
</li>
|
231
|
+
|
232
|
+
|
233
|
+
</ul>
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
<h2>
|
240
|
+
Instance Method Summary
|
241
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
242
|
+
</h2>
|
243
|
+
|
244
|
+
<ul class="summary">
|
245
|
+
|
246
|
+
<li class="public ">
|
247
|
+
<span class="summary_signature">
|
248
|
+
|
249
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Object) <strong>initialize</strong>(base_url, user_name, password, verify_cert) </a>
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
</span>
|
254
|
+
|
255
|
+
|
256
|
+
<span class="note title constructor">constructor</span>
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
<span class="summary_desc"><div class='inline'>
|
266
|
+
<p>Initializes a Vipr object that all methods can follow.</p>
|
267
|
+
</div></span>
|
268
|
+
|
269
|
+
</li>
|
270
|
+
|
271
|
+
|
272
|
+
</ul>
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="ViprHost.html" title="ViprHost (module)">ViprHost</a></span></h3>
|
285
|
+
<p class="inherited"><span class='object_link'><a href="ViprHost.html#add_host-instance_method" title="ViprHost#add_host (method)">#add_host</a></span>, <span class='object_link'><a href="ViprHost.html#add_host_initiator-instance_method" title="ViprHost#add_host_initiator (method)">#add_host_initiator</a></span>, <span class='object_link'><a href="ViprHost.html#check_host_get-instance_method" title="ViprHost#check_host_get (method)">#check_host_get</a></span>, <span class='object_link'><a href="ViprHost.html#check_host_post-instance_method" title="ViprHost#check_host_post (method)">#check_host_post</a></span>, <span class='object_link'><a href="ViprHost.html#check_host_post_initiator-instance_method" title="ViprHost#check_host_post_initiator (method)">#check_host_post_initiator</a></span>, <span class='object_link'><a href="ViprHost.html#deactivate_host-instance_method" title="ViprHost#deactivate_host (method)">#deactivate_host</a></span>, <span class='object_link'><a href="ViprHost.html#find_host_object-instance_method" title="ViprHost#find_host_object (method)">#find_host_object</a></span>, <span class='object_link'><a href="ViprHost.html#generate_host_post_json-instance_method" title="ViprHost#generate_host_post_json (method)">#generate_host_post_json</a></span>, <span class='object_link'><a href="ViprHost.html#generate_initiators_json-instance_method" title="ViprHost#generate_initiators_json (method)">#generate_initiators_json</a></span>, <span class='object_link'><a href="ViprHost.html#get_all_hosts-instance_method" title="ViprHost#get_all_hosts (method)">#get_all_hosts</a></span>, <span class='object_link'><a href="ViprHost.html#get_host-instance_method" title="ViprHost#get_host (method)">#get_host</a></span>, <span class='object_link'><a href="ViprHost.html#host_exists%3F-instance_method" title="ViprHost#host_exists? (method)">#host_exists?</a></span></p>
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="ViprStorageSystem.html" title="ViprStorageSystem (module)">ViprStorageSystem</a></span></h3>
|
296
|
+
<p class="inherited"><span class='object_link'><a href="ViprStorageSystem.html#add_emc_block-instance_method" title="ViprStorageSystem#add_emc_block (method)">#add_emc_block</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_emc_file-instance_method" title="ViprStorageSystem#add_emc_file (method)">#add_emc_file</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_hitachi-instance_method" title="ViprStorageSystem#add_hitachi (method)">#add_hitachi</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_isilon-instance_method" title="ViprStorageSystem#add_isilon (method)">#add_isilon</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_netapp-instance_method" title="ViprStorageSystem#add_netapp (method)">#add_netapp</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_scaleio-instance_method" title="ViprStorageSystem#add_scaleio (method)">#add_scaleio</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_third_party_block-instance_method" title="ViprStorageSystem#add_third_party_block (method)">#add_third_party_block</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#add_vplex-instance_method" title="ViprStorageSystem#add_vplex (method)">#add_vplex</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#check_storage_provider_payload-instance_method" title="ViprStorageSystem#check_storage_provider_payload (method)">#check_storage_provider_payload</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#storage_provider_payload-instance_method" title="ViprStorageSystem#storage_provider_payload (method)">#storage_provider_payload</a></span>, <span class='object_link'><a href="ViprStorageSystem.html#storage_system_payload-instance_method" title="ViprStorageSystem#storage_system_payload (method)">#storage_system_payload</a></span></p>
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="ViprVcenter.html" title="ViprVcenter (module)">ViprVcenter</a></span></h3>
|
307
|
+
<p class="inherited"><span class='object_link'><a href="ViprVcenter.html#add_vcenter-instance_method" title="ViprVcenter#add_vcenter (method)">#add_vcenter</a></span>, <span class='object_link'><a href="ViprVcenter.html#check_vcenter-instance_method" title="ViprVcenter#check_vcenter (method)">#check_vcenter</a></span>, <span class='object_link'><a href="ViprVcenter.html#check_vcenter_object_hash-instance_method" title="ViprVcenter#check_vcenter_object_hash (method)">#check_vcenter_object_hash</a></span>, <span class='object_link'><a href="ViprVcenter.html#check_vcenter_post-instance_method" title="ViprVcenter#check_vcenter_post (method)">#check_vcenter_post</a></span>, <span class='object_link'><a href="ViprVcenter.html#delete_vcenter-instance_method" title="ViprVcenter#delete_vcenter (method)">#delete_vcenter</a></span>, <span class='object_link'><a href="ViprVcenter.html#find_vcenter_object-instance_method" title="ViprVcenter#find_vcenter_object (method)">#find_vcenter_object</a></span>, <span class='object_link'><a href="ViprVcenter.html#get_all_vcenters-instance_method" title="ViprVcenter#get_all_vcenters (method)">#get_all_vcenters</a></span>, <span class='object_link'><a href="ViprVcenter.html#get_vcenter-instance_method" title="ViprVcenter#get_vcenter (method)">#get_vcenter</a></span>, <span class='object_link'><a href="ViprVcenter.html#get_vcenter_clusters-instance_method" title="ViprVcenter#get_vcenter_clusters (method)">#get_vcenter_clusters</a></span>, <span class='object_link'><a href="ViprVcenter.html#get_vcenter_datacenters-instance_method" title="ViprVcenter#get_vcenter_datacenters (method)">#get_vcenter_datacenters</a></span>, <span class='object_link'><a href="ViprVcenter.html#get_vcenter_hosts-instance_method" title="ViprVcenter#get_vcenter_hosts (method)">#get_vcenter_hosts</a></span></p>
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="ViprBase.html" title="ViprBase (module)">ViprBase</a></span></h3>
|
318
|
+
<p class="inherited"><span class='object_link'><a href="ViprBase.html#generate_base_url-instance_method" title="ViprBase#generate_base_url (method)">#generate_base_url</a></span>, <span class='object_link'><a href="ViprBase.html#get_auth_token-instance_method" title="ViprBase#get_auth_token (method)">#get_auth_token</a></span>, <span class='object_link'><a href="ViprBase.html#get_tenant_uid-instance_method" title="ViprBase#get_tenant_uid (method)">#get_tenant_uid</a></span>, <span class='object_link'><a href="ViprBase.html#login-instance_method" title="ViprBase#login (method)">#login</a></span>, <span class='object_link'><a href="ViprBase.html#rest_get-instance_method" title="ViprBase#rest_get (method)">#rest_get</a></span>, <span class='object_link'><a href="ViprBase.html#rest_post-instance_method" title="ViprBase#rest_post (method)">#rest_post</a></span>, <span class='object_link'><a href="ViprBase.html#to_boolean-instance_method" title="ViprBase#to_boolean (method)">#to_boolean</a></span></p>
|
319
|
+
<div id="constructor_details" class="method_details_list">
|
320
|
+
<h2>Constructor Details</h2>
|
321
|
+
|
322
|
+
<div class="method_details first">
|
323
|
+
<h3 class="signature first" id="initialize-instance_method">
|
324
|
+
|
325
|
+
- (<tt>Object</tt>) <strong>initialize</strong>(base_url, user_name, password, verify_cert)
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
</h3><div class="docstring">
|
332
|
+
<div class="discussion">
|
333
|
+
|
334
|
+
<div class="note notetag">
|
335
|
+
<strong>Note:</strong>
|
336
|
+
<div class='inline'>
|
337
|
+
<p>Every POST call requires a Tenant UID to create an object. This variable
|
338
|
+
gets the current logged in tenant information. Nothing else needs to be
|
339
|
+
done if there is a single tenant configured for ViPR If resources need to
|
340
|
+
be added to specific tenants, this variable must be overwritten by
|
341
|
+
specifying the tenant_uid</p>
|
342
|
+
</div>
|
343
|
+
</div>
|
344
|
+
|
345
|
+
|
346
|
+
<p>Initializes a Vipr object that all methods can follow.</p>
|
347
|
+
|
348
|
+
|
349
|
+
</div>
|
350
|
+
</div>
|
351
|
+
<div class="tags">
|
352
|
+
|
353
|
+
<div class="examples">
|
354
|
+
<p class="tag_title">Examples:</p>
|
355
|
+
|
356
|
+
|
357
|
+
<p class="example_title"><div class='inline'>
|
358
|
+
<p>New Vipruby Object</p>
|
359
|
+
</div></p>
|
360
|
+
|
361
|
+
<pre class="example code"><code><span class='id identifier rubyid_base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vipr.mydomain.com</span><span class='tstring_end'>'</span></span>
|
362
|
+
<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'>root</span><span class='tstring_end'>'</span></span>
|
363
|
+
<span class='id identifier rubyid_password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>mypw</span><span class='tstring_end'>'</span></span>
|
364
|
+
<span class='id identifier rubyid_verify_cert'>verify_cert</span> <span class='op'>=</span> <span class='kw'>false</span>
|
365
|
+
<span class='id identifier rubyid_vipr'>vipr</span> <span class='op'>=</span> <span class='const'>Vipr</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_base_url'>base_url</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_verify_cert'>verify_cert</span><span class='rparen'>)</span></code></pre>
|
366
|
+
|
367
|
+
</div>
|
368
|
+
<p class="tag_title">Parameters:</p>
|
369
|
+
<ul class="param">
|
370
|
+
|
371
|
+
<li>
|
372
|
+
|
373
|
+
<span class='name'>base_url</span>
|
374
|
+
|
375
|
+
|
376
|
+
<span class='type'>(<tt>String</tt>)</span>
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
—
|
381
|
+
<div class='inline'>
|
382
|
+
<p>The IP address or FQDN of the ViPR appliance. Do not include
|
383
|
+
'https' or port numbers</p>
|
384
|
+
</div>
|
385
|
+
|
386
|
+
</li>
|
387
|
+
|
388
|
+
<li>
|
389
|
+
|
390
|
+
<span class='name'>user_name</span>
|
391
|
+
|
392
|
+
|
393
|
+
<span class='type'>(<tt>String</tt>)</span>
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
—
|
398
|
+
<div class='inline'>
|
399
|
+
<p>Username used to log into ViPR</p>
|
400
|
+
</div>
|
401
|
+
|
402
|
+
</li>
|
403
|
+
|
404
|
+
<li>
|
405
|
+
|
406
|
+
<span class='name'>password</span>
|
407
|
+
|
408
|
+
|
409
|
+
<span class='type'>(<tt>String</tt>)</span>
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
—
|
414
|
+
<div class='inline'>
|
415
|
+
<p>Password used to log into ViPR</p>
|
416
|
+
</div>
|
417
|
+
|
418
|
+
</li>
|
419
|
+
|
420
|
+
<li>
|
421
|
+
|
422
|
+
<span class='name'>verify_cert</span>
|
423
|
+
|
424
|
+
|
425
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
426
|
+
|
427
|
+
|
428
|
+
|
429
|
+
—
|
430
|
+
<div class='inline'>
|
431
|
+
<p>Should the cert be SSL verified? Setting it to false will work for
|
432
|
+
development purposes. Should be set to true for production</p>
|
433
|
+
</div>
|
434
|
+
|
435
|
+
</li>
|
436
|
+
|
437
|
+
</ul>
|
438
|
+
|
439
|
+
|
440
|
+
</div><table class="source_code">
|
441
|
+
<tr>
|
442
|
+
<td>
|
443
|
+
<pre class="lines">
|
444
|
+
|
445
|
+
|
446
|
+
38
|
447
|
+
39
|
448
|
+
40
|
449
|
+
41
|
450
|
+
42
|
451
|
+
43</pre>
|
452
|
+
</td>
|
453
|
+
<td>
|
454
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/vipr.rb', line 38</span>
|
455
|
+
|
456
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_base_url'>base_url</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_verify_cert'>verify_cert</span><span class='rparen'>)</span>
|
457
|
+
<span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_generate_base_url'>generate_base_url</span><span class='lparen'>(</span><span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</span>
|
458
|
+
<span class='ivar'>@verify_cert</span> <span class='op'>=</span> <span class='id identifier rubyid_to_boolean'>to_boolean</span><span class='lparen'>(</span><span class='id identifier rubyid_verify_cert'>verify_cert</span><span class='rparen'>)</span>
|
459
|
+
<span class='ivar'>@auth_token</span> <span class='op'>=</span> <span class='id identifier rubyid_get_auth_token'>get_auth_token</span><span class='lparen'>(</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>
|
460
|
+
<span class='ivar'>@tenant_uid</span> <span class='op'>=</span> <span class='id identifier rubyid_get_tenant_uid'>get_tenant_uid</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>
|
461
|
+
<span class='kw'>end</span></pre>
|
462
|
+
</td>
|
463
|
+
</tr>
|
464
|
+
</table>
|
465
|
+
</div>
|
466
|
+
|
467
|
+
</div>
|
468
|
+
|
469
|
+
<div id="instance_attr_details" class="attr_details">
|
470
|
+
<h2>Instance Attribute Details</h2>
|
471
|
+
|
472
|
+
|
473
|
+
<span id="auth_token=-instance_method"></span>
|
474
|
+
<div class="method_details first">
|
475
|
+
<h3 class="signature first" id="auth_token-instance_method">
|
476
|
+
|
477
|
+
- (<tt>Object</tt>) <strong>auth_token</strong>
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
|
482
|
+
|
483
|
+
</h3><div class="docstring">
|
484
|
+
<div class="discussion">
|
485
|
+
|
486
|
+
<p>required params used for almost every single method</p>
|
487
|
+
|
488
|
+
|
489
|
+
</div>
|
490
|
+
</div>
|
491
|
+
<div class="tags">
|
492
|
+
|
493
|
+
|
494
|
+
</div><table class="source_code">
|
495
|
+
<tr>
|
496
|
+
<td>
|
497
|
+
<pre class="lines">
|
498
|
+
|
499
|
+
|
500
|
+
15
|
501
|
+
16
|
502
|
+
17</pre>
|
503
|
+
</td>
|
504
|
+
<td>
|
505
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/vipr.rb', line 15</span>
|
506
|
+
|
507
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_auth_token'>auth_token</span>
|
508
|
+
<span class='ivar'>@auth_token</span>
|
509
|
+
<span class='kw'>end</span></pre>
|
510
|
+
</td>
|
511
|
+
</tr>
|
512
|
+
</table>
|
513
|
+
</div>
|
514
|
+
|
515
|
+
|
516
|
+
<span id="base_url=-instance_method"></span>
|
517
|
+
<div class="method_details ">
|
518
|
+
<h3 class="signature " id="base_url-instance_method">
|
519
|
+
|
520
|
+
- (<tt>Object</tt>) <strong>base_url</strong>
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
</h3><div class="docstring">
|
527
|
+
<div class="discussion">
|
528
|
+
|
529
|
+
<p>required params used for almost every single method</p>
|
530
|
+
|
531
|
+
|
532
|
+
</div>
|
533
|
+
</div>
|
534
|
+
<div class="tags">
|
535
|
+
|
536
|
+
|
537
|
+
</div><table class="source_code">
|
538
|
+
<tr>
|
539
|
+
<td>
|
540
|
+
<pre class="lines">
|
541
|
+
|
542
|
+
|
543
|
+
15
|
544
|
+
16
|
545
|
+
17</pre>
|
546
|
+
</td>
|
547
|
+
<td>
|
548
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/vipr.rb', line 15</span>
|
549
|
+
|
550
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
|
551
|
+
<span class='ivar'>@base_url</span>
|
552
|
+
<span class='kw'>end</span></pre>
|
553
|
+
</td>
|
554
|
+
</tr>
|
555
|
+
</table>
|
556
|
+
</div>
|
557
|
+
|
558
|
+
|
559
|
+
<span id="tenant_uid=-instance_method"></span>
|
560
|
+
<div class="method_details ">
|
561
|
+
<h3 class="signature " id="tenant_uid-instance_method">
|
562
|
+
|
563
|
+
- (<tt>Object</tt>) <strong>tenant_uid</strong>
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
</h3><div class="docstring">
|
570
|
+
<div class="discussion">
|
571
|
+
|
572
|
+
<p>required params used for almost every single method</p>
|
573
|
+
|
574
|
+
|
575
|
+
</div>
|
576
|
+
</div>
|
577
|
+
<div class="tags">
|
578
|
+
|
579
|
+
|
580
|
+
</div><table class="source_code">
|
581
|
+
<tr>
|
582
|
+
<td>
|
583
|
+
<pre class="lines">
|
584
|
+
|
585
|
+
|
586
|
+
15
|
587
|
+
16
|
588
|
+
17</pre>
|
589
|
+
</td>
|
590
|
+
<td>
|
591
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/vipr.rb', line 15</span>
|
592
|
+
|
593
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_tenant_uid'>tenant_uid</span>
|
594
|
+
<span class='ivar'>@tenant_uid</span>
|
595
|
+
<span class='kw'>end</span></pre>
|
596
|
+
</td>
|
597
|
+
</tr>
|
598
|
+
</table>
|
599
|
+
</div>
|
600
|
+
|
601
|
+
|
602
|
+
<span id="verify_cert=-instance_method"></span>
|
603
|
+
<div class="method_details ">
|
604
|
+
<h3 class="signature " id="verify_cert-instance_method">
|
605
|
+
|
606
|
+
- (<tt>Object</tt>) <strong>verify_cert</strong>
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
|
612
|
+
</h3><div class="docstring">
|
613
|
+
<div class="discussion">
|
614
|
+
|
615
|
+
<p>required params used for almost every single method</p>
|
616
|
+
|
617
|
+
|
618
|
+
</div>
|
619
|
+
</div>
|
620
|
+
<div class="tags">
|
621
|
+
|
622
|
+
|
623
|
+
</div><table class="source_code">
|
624
|
+
<tr>
|
625
|
+
<td>
|
626
|
+
<pre class="lines">
|
627
|
+
|
628
|
+
|
629
|
+
15
|
630
|
+
16
|
631
|
+
17</pre>
|
632
|
+
</td>
|
633
|
+
<td>
|
634
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/vipr.rb', line 15</span>
|
635
|
+
|
636
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_verify_cert'>verify_cert</span>
|
637
|
+
<span class='ivar'>@verify_cert</span>
|
638
|
+
<span class='kw'>end</span></pre>
|
639
|
+
</td>
|
640
|
+
</tr>
|
641
|
+
</table>
|
642
|
+
</div>
|
643
|
+
|
644
|
+
</div>
|
645
|
+
|
646
|
+
|
647
|
+
</div>
|
648
|
+
|
649
|
+
<div id="footer">
|
650
|
+
Generated on Mon Dec 15 13:52:44 2014 by
|
651
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
652
|
+
0.8.7.6 (ruby-2.1.2).
|
653
|
+
</div>
|
654
|
+
|
655
|
+
</body>
|
656
|
+
</html>
|