vipruby 0.1.7 → 0.1.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardoc/checksums +14 -4
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/{LICENSE.txt → LICENSE} +2 -2
- data/README.md +94 -12
- data/doc/Vipr.html +139 -29
- data/doc/ViprAutoTier.html +426 -0
- data/doc/ViprBase.html +1 -1
- data/doc/ViprBlockVirtualPool.html +859 -0
- data/doc/ViprFileVirtualPool.html +859 -0
- data/doc/ViprHost.html +1 -1
- data/doc/ViprServiceCatalog.html +800 -0
- data/doc/ViprStoragePool.html +664 -0
- data/doc/ViprStoragePort.html +664 -0
- data/doc/ViprStorageSystem.html +2588 -805
- data/doc/ViprStorageTier.html +323 -0
- data/doc/ViprTenant.html +529 -0
- data/doc/ViprVcenter.html +1 -1
- data/doc/ViprVirtualArray.html +1230 -0
- data/doc/ViprVirtualDataCenter.html +407 -0
- data/doc/Vipruby.html +2 -2
- data/doc/_index.html +51 -1
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +71 -26
- data/doc/index.html +71 -26
- data/doc/method_list.html +438 -12
- data/doc/top-level-namespace.html +2 -2
- data/lib/doc/_index.html +88 -0
- data/lib/doc/class_list.html +58 -0
- data/lib/doc/css/common.css +1 -0
- data/lib/doc/css/full_list.css +57 -0
- data/lib/doc/css/style.css +339 -0
- data/lib/doc/file_list.html +57 -0
- data/lib/doc/frames.html +26 -0
- data/lib/doc/index.html +88 -0
- data/lib/doc/js/app.js +219 -0
- data/lib/doc/js/full_list.js +181 -0
- data/lib/doc/js/jquery.js +4 -0
- data/lib/doc/method_list.html +57 -0
- data/lib/doc/top-level-namespace.html +102 -0
- data/lib/vipruby.rb +1 -5
- data/lib/vipruby/objects/autotier.rb +30 -0
- data/lib/vipruby/objects/blockvirtualpool.rb +74 -0
- data/lib/vipruby/objects/filevirtualpool.rb +74 -0
- data/lib/vipruby/objects/servicecatalog.rb +81 -0
- data/lib/vipruby/objects/storagepool.rb +80 -0
- data/lib/vipruby/objects/storageport.rb +62 -0
- data/lib/vipruby/objects/storagesystem.rb +169 -0
- data/lib/vipruby/objects/storagetier.rb +21 -0
- data/lib/vipruby/objects/tenant.rb +39 -0
- data/lib/vipruby/objects/virtualarray.rb +100 -0
- data/lib/vipruby/objects/virtualdatacenter.rb +28 -0
- data/lib/vipruby/version.rb +1 -1
- data/lib/vipruby/vipr.rb +25 -5
- data/vipruby.gemspec +2 -2
- metadata +39 -6
@@ -0,0 +1,323 @@
|
|
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: ViprStorageTier
|
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#!ViprStorageTier.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">ViprStorageTier</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: ViprStorageTier
|
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/storagetier.rb</dd>
|
87
|
+
|
88
|
+
</dl>
|
89
|
+
<div class="clear"></div>
|
90
|
+
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
92
|
+
<div class="discussion">
|
93
|
+
|
94
|
+
<p>The following Storage Tier calls will get and execute Storage Tier items</p>
|
95
|
+
|
96
|
+
|
97
|
+
</div>
|
98
|
+
</div>
|
99
|
+
<div class="tags">
|
100
|
+
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
<h2>
|
111
|
+
Instance Method Summary
|
112
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
113
|
+
</h2>
|
114
|
+
|
115
|
+
<ul class="summary">
|
116
|
+
|
117
|
+
<li class="public ">
|
118
|
+
<span class="summary_signature">
|
119
|
+
|
120
|
+
<a href="#get_storage_tier-instance_method" title="#get_storage_tier (instance method)">- (JSON) <strong>get_storage_tier</strong>(storage_tier_id, 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>Get Single Storage Tier information.</p>
|
136
|
+
</div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
<li class="public ">
|
142
|
+
<span class="summary_signature">
|
143
|
+
|
144
|
+
<a href="#get_storage_tiers-instance_method" title="#get_storage_tiers (instance method)">- (json) <strong>get_storage_tiers</strong>(auth = nil, cert = nil) </a>
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
</span>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
159
|
+
<p>Get Storage Tiers.</p>
|
160
|
+
</div></span>
|
161
|
+
|
162
|
+
</li>
|
163
|
+
|
164
|
+
|
165
|
+
</ul>
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
<div id="instance_method_details" class="method_details_list">
|
171
|
+
<h2>Instance Method Details</h2>
|
172
|
+
|
173
|
+
|
174
|
+
<div class="method_details first">
|
175
|
+
<h3 class="signature first" id="get_storage_tier-instance_method">
|
176
|
+
|
177
|
+
- (<tt>JSON</tt>) <strong>get_storage_tier</strong>(storage_tier_id, auth = nil, cert = nil)
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
</h3><div class="docstring">
|
184
|
+
<div class="discussion">
|
185
|
+
|
186
|
+
<p>Get Single Storage Tier information</p>
|
187
|
+
|
188
|
+
|
189
|
+
</div>
|
190
|
+
</div>
|
191
|
+
<div class="tags">
|
192
|
+
<p class="tag_title">Parameters:</p>
|
193
|
+
<ul class="param">
|
194
|
+
|
195
|
+
<li>
|
196
|
+
|
197
|
+
<span class='name'>storage_tier_id</span>
|
198
|
+
|
199
|
+
|
200
|
+
<span class='type'>(<tt>urn:id</tt>)</span>
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
—
|
205
|
+
<div class='inline'>
|
206
|
+
<p>URN of a storage tier. Required Param</p>
|
207
|
+
</div>
|
208
|
+
|
209
|
+
</li>
|
210
|
+
|
211
|
+
</ul>
|
212
|
+
|
213
|
+
<p class="tag_title">Returns:</p>
|
214
|
+
<ul class="return">
|
215
|
+
|
216
|
+
<li>
|
217
|
+
|
218
|
+
|
219
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
—
|
224
|
+
<div class='inline'>
|
225
|
+
<p>The JSON object of the Storage Tier</p>
|
226
|
+
</div>
|
227
|
+
|
228
|
+
</li>
|
229
|
+
|
230
|
+
</ul>
|
231
|
+
|
232
|
+
</div><table class="source_code">
|
233
|
+
<tr>
|
234
|
+
<td>
|
235
|
+
<pre class="lines">
|
236
|
+
|
237
|
+
|
238
|
+
17
|
239
|
+
18
|
240
|
+
19</pre>
|
241
|
+
</td>
|
242
|
+
<td>
|
243
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagetier.rb', line 17</span>
|
244
|
+
|
245
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_storage_tier'>get_storage_tier</span><span class='lparen'>(</span><span class='id identifier rubyid_storage_tier_id'>storage_tier_id</span><span class='comma'>,</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
246
|
+
<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'>/vdc/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_storage_tier_id'>storage_tier_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>
|
247
|
+
<span class='kw'>end</span></pre>
|
248
|
+
</td>
|
249
|
+
</tr>
|
250
|
+
</table>
|
251
|
+
</div>
|
252
|
+
|
253
|
+
<div class="method_details ">
|
254
|
+
<h3 class="signature " id="get_storage_tiers-instance_method">
|
255
|
+
|
256
|
+
- (<tt>json</tt>) <strong>get_storage_tiers</strong>(auth = nil, cert = nil)
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</h3><div class="docstring">
|
263
|
+
<div class="discussion">
|
264
|
+
|
265
|
+
<p>Get Storage Tiers</p>
|
266
|
+
|
267
|
+
|
268
|
+
</div>
|
269
|
+
</div>
|
270
|
+
<div class="tags">
|
271
|
+
|
272
|
+
<p class="tag_title">Returns:</p>
|
273
|
+
<ul class="return">
|
274
|
+
|
275
|
+
<li>
|
276
|
+
|
277
|
+
|
278
|
+
<span class='type'>(<tt>json</tt>)</span>
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
—
|
283
|
+
<div class='inline'>
|
284
|
+
<p>JSON object of all the Storage Tiers</p>
|
285
|
+
</div>
|
286
|
+
|
287
|
+
</li>
|
288
|
+
|
289
|
+
</ul>
|
290
|
+
|
291
|
+
</div><table class="source_code">
|
292
|
+
<tr>
|
293
|
+
<td>
|
294
|
+
<pre class="lines">
|
295
|
+
|
296
|
+
|
297
|
+
8
|
298
|
+
9
|
299
|
+
10</pre>
|
300
|
+
</td>
|
301
|
+
<td>
|
302
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/storagetier.rb', line 8</span>
|
303
|
+
|
304
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_storage_tiers'>get_storage_tiers</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>
|
305
|
+
<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'>/vdc/storage-tiers</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>
|
306
|
+
<span class='kw'>end</span></pre>
|
307
|
+
</td>
|
308
|
+
</tr>
|
309
|
+
</table>
|
310
|
+
</div>
|
311
|
+
|
312
|
+
</div>
|
313
|
+
|
314
|
+
</div>
|
315
|
+
|
316
|
+
<div id="footer">
|
317
|
+
Generated on Mon Jun 1 15:10:33 2015 by
|
318
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
319
|
+
0.8.7.6 (ruby-2.1.2).
|
320
|
+
</div>
|
321
|
+
|
322
|
+
</body>
|
323
|
+
</html>
|
data/doc/ViprTenant.html
ADDED
@@ -0,0 +1,529 @@
|
|
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: ViprTenant
|
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#!ViprTenant.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">ViprTenant</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: ViprTenant
|
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/tenant.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 Tenant calls will get and execute tenant items</p>
|
95
|
+
|
96
|
+
|
97
|
+
</div>
|
98
|
+
</div>
|
99
|
+
<div class="tags">
|
100
|
+
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
<h2>
|
111
|
+
Instance Method Summary
|
112
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
113
|
+
</h2>
|
114
|
+
|
115
|
+
<ul class="summary">
|
116
|
+
|
117
|
+
<li class="public ">
|
118
|
+
<span class="summary_signature">
|
119
|
+
|
120
|
+
<a href="#get_subtenants-instance_method" title="#get_subtenants (instance method)">- (JSON) <strong>get_subtenants</strong>(tenant_id, 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>Get single tenant subtenants information.</p>
|
136
|
+
</div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
<li class="public ">
|
142
|
+
<span class="summary_signature">
|
143
|
+
|
144
|
+
<a href="#get_tenant-instance_method" title="#get_tenant (instance method)">- (JSON) <strong>get_tenant</strong>(tenant_id, auth = nil, cert = nil) </a>
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
</span>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
159
|
+
<p>Get single tenant information.</p>
|
160
|
+
</div></span>
|
161
|
+
|
162
|
+
</li>
|
163
|
+
|
164
|
+
|
165
|
+
<li class="public ">
|
166
|
+
<span class="summary_signature">
|
167
|
+
|
168
|
+
<a href="#get_tenant_projects-instance_method" title="#get_tenant_projects (instance method)">- (JSON) <strong>get_tenant_projects</strong>(tenant_id, auth = nil, cert = nil) </a>
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
</span>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
<span class="summary_desc"><div class='inline'>
|
183
|
+
<p>Get single tenant projects information.</p>
|
184
|
+
</div></span>
|
185
|
+
|
186
|
+
</li>
|
187
|
+
|
188
|
+
|
189
|
+
<li class="public ">
|
190
|
+
<span class="summary_signature">
|
191
|
+
|
192
|
+
<a href="#get_tenants-instance_method" title="#get_tenants (instance method)">- (json) <strong>get_tenants</strong>(auth = nil, cert = nil) </a>
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
</span>
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
<span class="summary_desc"><div class='inline'>
|
207
|
+
<p>Get tenants.</p>
|
208
|
+
</div></span>
|
209
|
+
|
210
|
+
</li>
|
211
|
+
|
212
|
+
|
213
|
+
</ul>
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
<div id="instance_method_details" class="method_details_list">
|
219
|
+
<h2>Instance Method Details</h2>
|
220
|
+
|
221
|
+
|
222
|
+
<div class="method_details first">
|
223
|
+
<h3 class="signature first" id="get_subtenants-instance_method">
|
224
|
+
|
225
|
+
- (<tt>JSON</tt>) <strong>get_subtenants</strong>(tenant_id, auth = nil, cert = nil)
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
</h3><div class="docstring">
|
232
|
+
<div class="discussion">
|
233
|
+
|
234
|
+
<p>Get single tenant subtenants information</p>
|
235
|
+
|
236
|
+
|
237
|
+
</div>
|
238
|
+
</div>
|
239
|
+
<div class="tags">
|
240
|
+
<p class="tag_title">Parameters:</p>
|
241
|
+
<ul class="param">
|
242
|
+
|
243
|
+
<li>
|
244
|
+
|
245
|
+
<span class='name'>tenant_id</span>
|
246
|
+
|
247
|
+
|
248
|
+
<span class='type'>(<tt>urn:id</tt>)</span>
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
—
|
253
|
+
<div class='inline'>
|
254
|
+
<p>URN of a tenant. Required Param</p>
|
255
|
+
</div>
|
256
|
+
|
257
|
+
</li>
|
258
|
+
|
259
|
+
</ul>
|
260
|
+
|
261
|
+
<p class="tag_title">Returns:</p>
|
262
|
+
<ul class="return">
|
263
|
+
|
264
|
+
<li>
|
265
|
+
|
266
|
+
|
267
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
—
|
272
|
+
<div class='inline'>
|
273
|
+
<p>The JSON object of all subtenants of a tenant</p>
|
274
|
+
</div>
|
275
|
+
|
276
|
+
</li>
|
277
|
+
|
278
|
+
</ul>
|
279
|
+
|
280
|
+
</div><table class="source_code">
|
281
|
+
<tr>
|
282
|
+
<td>
|
283
|
+
<pre class="lines">
|
284
|
+
|
285
|
+
|
286
|
+
26
|
287
|
+
27
|
288
|
+
28</pre>
|
289
|
+
</td>
|
290
|
+
<td>
|
291
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/tenant.rb', line 26</span>
|
292
|
+
|
293
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_subtenants'>get_subtenants</span><span class='lparen'>(</span><span class='id identifier rubyid_tenant_id'>tenant_id</span><span class='comma'>,</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
294
|
+
<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='id identifier rubyid_tenant_id'>tenant_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/subtenants</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>
|
295
|
+
<span class='kw'>end</span></pre>
|
296
|
+
</td>
|
297
|
+
</tr>
|
298
|
+
</table>
|
299
|
+
</div>
|
300
|
+
|
301
|
+
<div class="method_details ">
|
302
|
+
<h3 class="signature " id="get_tenant-instance_method">
|
303
|
+
|
304
|
+
- (<tt>JSON</tt>) <strong>get_tenant</strong>(tenant_id, auth = nil, cert = nil)
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
</h3><div class="docstring">
|
311
|
+
<div class="discussion">
|
312
|
+
|
313
|
+
<p>Get single tenant information</p>
|
314
|
+
|
315
|
+
|
316
|
+
</div>
|
317
|
+
</div>
|
318
|
+
<div class="tags">
|
319
|
+
<p class="tag_title">Parameters:</p>
|
320
|
+
<ul class="param">
|
321
|
+
|
322
|
+
<li>
|
323
|
+
|
324
|
+
<span class='name'>tenant_id</span>
|
325
|
+
|
326
|
+
|
327
|
+
<span class='type'>(<tt>urn:id</tt>)</span>
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
—
|
332
|
+
<div class='inline'>
|
333
|
+
<p>URN of a tenant. Required Param</p>
|
334
|
+
</div>
|
335
|
+
|
336
|
+
</li>
|
337
|
+
|
338
|
+
</ul>
|
339
|
+
|
340
|
+
<p class="tag_title">Returns:</p>
|
341
|
+
<ul class="return">
|
342
|
+
|
343
|
+
<li>
|
344
|
+
|
345
|
+
|
346
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
—
|
351
|
+
<div class='inline'>
|
352
|
+
<p>The JSON object of the tenant</p>
|
353
|
+
</div>
|
354
|
+
|
355
|
+
</li>
|
356
|
+
|
357
|
+
</ul>
|
358
|
+
|
359
|
+
</div><table class="source_code">
|
360
|
+
<tr>
|
361
|
+
<td>
|
362
|
+
<pre class="lines">
|
363
|
+
|
364
|
+
|
365
|
+
17
|
366
|
+
18
|
367
|
+
19</pre>
|
368
|
+
</td>
|
369
|
+
<td>
|
370
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/tenant.rb', line 17</span>
|
371
|
+
|
372
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_tenant'>get_tenant</span><span class='lparen'>(</span><span class='id identifier rubyid_tenant_id'>tenant_id</span><span class='comma'>,</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
373
|
+
<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='id identifier rubyid_tenant_id'>tenant_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>
|
374
|
+
<span class='kw'>end</span></pre>
|
375
|
+
</td>
|
376
|
+
</tr>
|
377
|
+
</table>
|
378
|
+
</div>
|
379
|
+
|
380
|
+
<div class="method_details ">
|
381
|
+
<h3 class="signature " id="get_tenant_projects-instance_method">
|
382
|
+
|
383
|
+
- (<tt>JSON</tt>) <strong>get_tenant_projects</strong>(tenant_id, auth = nil, cert = nil)
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
</h3><div class="docstring">
|
390
|
+
<div class="discussion">
|
391
|
+
|
392
|
+
<p>Get single tenant projects information</p>
|
393
|
+
|
394
|
+
|
395
|
+
</div>
|
396
|
+
</div>
|
397
|
+
<div class="tags">
|
398
|
+
<p class="tag_title">Parameters:</p>
|
399
|
+
<ul class="param">
|
400
|
+
|
401
|
+
<li>
|
402
|
+
|
403
|
+
<span class='name'>tenant_id</span>
|
404
|
+
|
405
|
+
|
406
|
+
<span class='type'>(<tt>urn:id</tt>)</span>
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
—
|
411
|
+
<div class='inline'>
|
412
|
+
<p>URN of a tenant. Required Param</p>
|
413
|
+
</div>
|
414
|
+
|
415
|
+
</li>
|
416
|
+
|
417
|
+
</ul>
|
418
|
+
|
419
|
+
<p class="tag_title">Returns:</p>
|
420
|
+
<ul class="return">
|
421
|
+
|
422
|
+
<li>
|
423
|
+
|
424
|
+
|
425
|
+
<span class='type'>(<tt>JSON</tt>)</span>
|
426
|
+
|
427
|
+
|
428
|
+
|
429
|
+
—
|
430
|
+
<div class='inline'>
|
431
|
+
<p>The JSON object of all projects of a tenant</p>
|
432
|
+
</div>
|
433
|
+
|
434
|
+
</li>
|
435
|
+
|
436
|
+
</ul>
|
437
|
+
|
438
|
+
</div><table class="source_code">
|
439
|
+
<tr>
|
440
|
+
<td>
|
441
|
+
<pre class="lines">
|
442
|
+
|
443
|
+
|
444
|
+
35
|
445
|
+
36
|
446
|
+
37</pre>
|
447
|
+
</td>
|
448
|
+
<td>
|
449
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/tenant.rb', line 35</span>
|
450
|
+
|
451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_tenant_projects'>get_tenant_projects</span><span class='lparen'>(</span><span class='id identifier rubyid_tenant_id'>tenant_id</span><span class='comma'>,</span><span class='id identifier rubyid_auth'>auth</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_cert'>cert</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
452
|
+
<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='id identifier rubyid_tenant_id'>tenant_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/projects</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>
|
453
|
+
<span class='kw'>end</span></pre>
|
454
|
+
</td>
|
455
|
+
</tr>
|
456
|
+
</table>
|
457
|
+
</div>
|
458
|
+
|
459
|
+
<div class="method_details ">
|
460
|
+
<h3 class="signature " id="get_tenants-instance_method">
|
461
|
+
|
462
|
+
- (<tt>json</tt>) <strong>get_tenants</strong>(auth = nil, cert = nil)
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
</h3><div class="docstring">
|
469
|
+
<div class="discussion">
|
470
|
+
|
471
|
+
<p>Get tenants</p>
|
472
|
+
|
473
|
+
|
474
|
+
</div>
|
475
|
+
</div>
|
476
|
+
<div class="tags">
|
477
|
+
|
478
|
+
<p class="tag_title">Returns:</p>
|
479
|
+
<ul class="return">
|
480
|
+
|
481
|
+
<li>
|
482
|
+
|
483
|
+
|
484
|
+
<span class='type'>(<tt>json</tt>)</span>
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
—
|
489
|
+
<div class='inline'>
|
490
|
+
<p>JSON object of all the tenants in URN forman</p>
|
491
|
+
</div>
|
492
|
+
|
493
|
+
</li>
|
494
|
+
|
495
|
+
</ul>
|
496
|
+
|
497
|
+
</div><table class="source_code">
|
498
|
+
<tr>
|
499
|
+
<td>
|
500
|
+
<pre class="lines">
|
501
|
+
|
502
|
+
|
503
|
+
8
|
504
|
+
9
|
505
|
+
10</pre>
|
506
|
+
</td>
|
507
|
+
<td>
|
508
|
+
<pre class="code"><span class="info file"># File 'lib/vipruby/objects/tenant.rb', line 8</span>
|
509
|
+
|
510
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_tenants'>get_tenants</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>
|
511
|
+
<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/bulk</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>
|
512
|
+
<span class='kw'>end</span></pre>
|
513
|
+
</td>
|
514
|
+
</tr>
|
515
|
+
</table>
|
516
|
+
</div>
|
517
|
+
|
518
|
+
</div>
|
519
|
+
|
520
|
+
</div>
|
521
|
+
|
522
|
+
<div id="footer">
|
523
|
+
Generated on Mon Jun 1 15:10:33 2015 by
|
524
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
525
|
+
0.8.7.6 (ruby-2.1.2).
|
526
|
+
</div>
|
527
|
+
|
528
|
+
</body>
|
529
|
+
</html>
|