foreman_api 0.1.1 → 0.1.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.
- data/.gitignore +3 -0
- data/Gemfile +2 -0
- data/Rakefile +0 -1
- data/doc/ForemanApi.html +5 -5
- data/doc/ForemanApi/Resources.html +6 -6
- data/doc/ForemanApi/Resources/Architecture.html +260 -127
- data/doc/ForemanApi/Resources/Audit.html +118 -51
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +314 -163
- data/doc/ForemanApi/Resources/Bookmark.html +266 -131
- data/doc/ForemanApi/Resources/CommonParameter.html +260 -127
- data/doc/ForemanApi/Resources/ComputeResource.html +314 -165
- data/doc/ForemanApi/Resources/ConfigTemplate.html +387 -195
- data/doc/ForemanApi/Resources/Dashboard.html +53 -27
- data/doc/ForemanApi/Resources/Domain.html +275 -137
- data/doc/ForemanApi/Resources/Environment.html +254 -123
- data/doc/ForemanApi/Resources/FactValue.html +75 -32
- data/doc/ForemanApi/Resources/Home.html +92 -43
- data/doc/ForemanApi/Resources/Host.html +401 -212
- data/doc/ForemanApi/Resources/HostClass.html +698 -0
- data/doc/ForemanApi/Resources/Hostgroup.html +308 -159
- data/doc/ForemanApi/Resources/HostgroupClass.html +712 -0
- data/doc/ForemanApi/Resources/Image.html +284 -143
- data/doc/ForemanApi/Resources/LookupKey.html +295 -140
- data/doc/ForemanApi/Resources/Medium.html +278 -145
- data/doc/ForemanApi/Resources/Model.html +272 -135
- data/doc/ForemanApi/Resources/OperatingSystem.html +323 -160
- data/doc/ForemanApi/Resources/Parameter.html +1512 -0
- data/doc/ForemanApi/Resources/Ptable.html +266 -131
- data/doc/ForemanApi/Resources/Puppetclass.html +295 -131
- data/doc/ForemanApi/Resources/Report.html +311 -71
- data/doc/ForemanApi/Resources/Role.html +248 -119
- data/doc/ForemanApi/Resources/Setting.html +156 -76
- data/doc/ForemanApi/Resources/SmartProxy.html +257 -125
- data/doc/ForemanApi/Resources/Subnet.html +332 -175
- data/doc/ForemanApi/Resources/TemplateCombination.html +826 -0
- data/doc/ForemanApi/Resources/TemplateKind.html +56 -29
- data/doc/ForemanApi/Resources/User.html +287 -145
- data/doc/ForemanApi/Resources/Usergroup.html +272 -115
- data/doc/_index.html +32 -4
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +10 -0
- data/doc/file.MIT-LICENSE.html +29 -24
- data/doc/file.README.html +60 -59
- data/doc/frames.html +1 -1
- data/doc/index.html +60 -59
- data/doc/method_list.html +434 -266
- data/doc/top-level-namespace.html +3 -3
- data/lib/foreman_api.rb +0 -13
- data/lib/foreman_api/base.rb +77 -7
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/architecture.rb +27 -32
- data/lib/foreman_api/resources/audit.rb +9 -10
- data/lib/foreman_api/resources/auth_source_ldap.rb +47 -52
- data/lib/foreman_api/resources/bookmark.rb +31 -36
- data/lib/foreman_api/resources/common_parameter.rb +27 -32
- data/lib/foreman_api/resources/compute_resource.rb +43 -48
- data/lib/foreman_api/resources/config_template.rb +43 -50
- data/lib/foreman_api/resources/dashboard.rb +4 -5
- data/lib/foreman_api/resources/domain.rb +30 -35
- data/lib/foreman_api/resources/environment.rb +25 -30
- data/lib/foreman_api/resources/fact_value.rb +5 -5
- data/lib/foreman_api/resources/home.rb +7 -9
- data/lib/foreman_api/resources/host.rb +63 -69
- data/lib/foreman_api/resources/host_class.rb +39 -0
- data/lib/foreman_api/resources/hostgroup.rb +43 -48
- data/lib/foreman_api/resources/hostgroup_class.rb +40 -0
- data/lib/foreman_api/resources/image.rb +40 -45
- data/lib/foreman_api/resources/lookup_key.rb +36 -40
- data/lib/foreman_api/resources/medium.rb +29 -34
- data/lib/foreman_api/resources/model.rb +31 -36
- data/lib/foreman_api/resources/operating_system.rb +39 -45
- data/lib/foreman_api/resources/parameter.rb +96 -0
- data/lib/foreman_api/resources/ptable.rb +29 -34
- data/lib/foreman_api/resources/puppetclass.rb +31 -34
- data/lib/foreman_api/resources/report.rb +17 -20
- data/lib/foreman_api/resources/role.rb +25 -30
- data/lib/foreman_api/resources/setting.rb +15 -18
- data/lib/foreman_api/resources/smart_proxy.rb +27 -32
- data/lib/foreman_api/resources/subnet.rb +47 -52
- data/lib/foreman_api/resources/template_combination.rb +21 -25
- data/lib/foreman_api/resources/template_kind.rb +4 -5
- data/lib/foreman_api/resources/user.rb +36 -41
- data/lib/foreman_api/resources/usergroup.rb +25 -30
- data/lib/foreman_api/version.rb +1 -1
- metadata +10 -2
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ForemanApi::Resources::ComputeResource
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -150,7 +150,7 @@
|
|
150
150
|
<li class="public ">
|
151
151
|
<span class="summary_signature">
|
152
152
|
|
153
|
-
<a href="#create-instance_method" title="#create (instance method)">- (
|
153
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
|
154
154
|
|
155
155
|
|
156
156
|
|
@@ -164,7 +164,10 @@
|
|
164
164
|
|
165
165
|
|
166
166
|
|
167
|
-
<span class="summary_desc"><div class='inline'
|
167
|
+
<span class="summary_desc"><div class='inline'><p>
|
168
|
+
First item: parsed data; second item: raw body.
|
169
|
+
</p>
|
170
|
+
</div></span>
|
168
171
|
|
169
172
|
</li>
|
170
173
|
|
@@ -172,7 +175,7 @@
|
|
172
175
|
<li class="public ">
|
173
176
|
<span class="summary_signature">
|
174
177
|
|
175
|
-
<a href="#destroy-instance_method" title="#destroy (instance method)">- (
|
178
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
|
176
179
|
|
177
180
|
|
178
181
|
|
@@ -186,7 +189,10 @@
|
|
186
189
|
|
187
190
|
|
188
191
|
|
189
|
-
<span class="summary_desc"><div class='inline'
|
192
|
+
<span class="summary_desc"><div class='inline'><p>
|
193
|
+
First item: parsed data; second item: raw body.
|
194
|
+
</p>
|
195
|
+
</div></span>
|
190
196
|
|
191
197
|
</li>
|
192
198
|
|
@@ -194,7 +200,7 @@
|
|
194
200
|
<li class="public ">
|
195
201
|
<span class="summary_signature">
|
196
202
|
|
197
|
-
<a href="#index-instance_method" title="#index (instance method)">- (
|
203
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
198
204
|
|
199
205
|
|
200
206
|
|
@@ -208,7 +214,10 @@
|
|
208
214
|
|
209
215
|
|
210
216
|
|
211
|
-
<span class="summary_desc"><div class='inline'
|
217
|
+
<span class="summary_desc"><div class='inline'><p>
|
218
|
+
First item: parsed data; second item: raw body.
|
219
|
+
</p>
|
220
|
+
</div></span>
|
212
221
|
|
213
222
|
</li>
|
214
223
|
|
@@ -216,7 +225,7 @@
|
|
216
225
|
<li class="public ">
|
217
226
|
<span class="summary_signature">
|
218
227
|
|
219
|
-
<a href="#show-instance_method" title="#show (instance method)">- (
|
228
|
+
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
|
220
229
|
|
221
230
|
|
222
231
|
|
@@ -230,7 +239,10 @@
|
|
230
239
|
|
231
240
|
|
232
241
|
|
233
|
-
<span class="summary_desc"><div class='inline'
|
242
|
+
<span class="summary_desc"><div class='inline'><p>
|
243
|
+
First item: parsed data; second item: raw body.
|
244
|
+
</p>
|
245
|
+
</div></span>
|
234
246
|
|
235
247
|
</li>
|
236
248
|
|
@@ -238,7 +250,7 @@
|
|
238
250
|
<li class="public ">
|
239
251
|
<span class="summary_signature">
|
240
252
|
|
241
|
-
<a href="#update-instance_method" title="#update (instance method)">- (
|
253
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
|
242
254
|
|
243
255
|
|
244
256
|
|
@@ -252,7 +264,10 @@
|
|
252
264
|
|
253
265
|
|
254
266
|
|
255
|
-
<span class="summary_desc"><div class='inline'
|
267
|
+
<span class="summary_desc"><div class='inline'><p>
|
268
|
+
First item: parsed data; second item: raw body.
|
269
|
+
</p>
|
270
|
+
</div></span>
|
256
271
|
|
257
272
|
</li>
|
258
273
|
|
@@ -289,9 +304,10 @@
|
|
289
304
|
<td>
|
290
305
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line 4</span>
|
291
306
|
|
292
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='
|
293
|
-
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='
|
294
|
-
<span class='kw'>end</span
|
307
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
|
308
|
+
<span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_ForemanApi constant id'>ForemanApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>"compute_resources"</span><span class='rbrack token'>]</span>
|
309
|
+
<span class='rubyid_end end kw'>end</span>
|
310
|
+
</pre>
|
295
311
|
</td>
|
296
312
|
</tr>
|
297
313
|
</table>
|
@@ -306,7 +322,7 @@
|
|
306
322
|
<div class="method_details first">
|
307
323
|
<h3 class="signature first" id="create-instance_method">
|
308
324
|
|
309
|
-
- (<tt>
|
325
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
310
326
|
|
311
327
|
|
312
328
|
|
@@ -314,7 +330,10 @@
|
|
314
330
|
|
315
331
|
</h3><div class="docstring">
|
316
332
|
<div class="discussion">
|
317
|
-
|
333
|
+
<p>
|
334
|
+
First item: parsed data; second item: raw body
|
335
|
+
</p>
|
336
|
+
|
318
337
|
|
319
338
|
</div>
|
320
339
|
</div>
|
@@ -330,12 +349,13 @@
|
|
330
349
|
<span class='type'>(<tt>Hash</tt>)</span>
|
331
350
|
|
332
351
|
|
333
|
-
<em class="default">(defaults to: <tt>{
|
352
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
334
353
|
|
335
354
|
|
336
355
|
—
|
337
|
-
<div class='inline'>
|
338
|
-
|
356
|
+
<div class='inline'><p>
|
357
|
+
a hash of params to be passed to the service
|
358
|
+
</p>
|
339
359
|
</div>
|
340
360
|
|
341
361
|
</li>
|
@@ -348,12 +368,13 @@
|
|
348
368
|
<span class='type'>(<tt>Hash</tt>)</span>
|
349
369
|
|
350
370
|
|
351
|
-
<em class="default">(defaults to: <tt>{
|
371
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
352
372
|
|
353
373
|
|
354
374
|
—
|
355
|
-
<div class='inline'>
|
356
|
-
|
375
|
+
<div class='inline'><p>
|
376
|
+
additional http headers
|
377
|
+
</p>
|
357
378
|
</div>
|
358
379
|
|
359
380
|
</li>
|
@@ -373,32 +394,44 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
</li
|
383
|
-
<
|
384
|
-
|
385
|
-
</li
|
386
|
-
<
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
</li
|
397
|
-
<
|
398
|
-
|
399
|
-
</li
|
400
|
-
<
|
401
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>description [String]
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>name [String]
|
405
|
+
|
406
|
+
</li>
|
407
|
+
<li>password [String] Password for ovirt, ec2, vmware, openstack. secret key
|
408
|
+
for ec2
|
409
|
+
|
410
|
+
</li>
|
411
|
+
<li>provider [String] Providers include libvirt, ovirt, ec2, vmware, openstack,
|
412
|
+
rackspace
|
413
|
+
|
414
|
+
</li>
|
415
|
+
<li>region [String] For ec2 only
|
416
|
+
|
417
|
+
</li>
|
418
|
+
<li>server [String] For vmware
|
419
|
+
|
420
|
+
</li>
|
421
|
+
<li>tenant [String] For openstack only
|
422
|
+
|
423
|
+
</li>
|
424
|
+
<li>url [String] Url for libvirt, ovirt, and openstack
|
425
|
+
|
426
|
+
</li>
|
427
|
+
<li>user [String] Username for ovirt, ec2, vmware, openstack. access key for
|
428
|
+
ec2.
|
429
|
+
|
430
|
+
</li>
|
431
|
+
<li>uuid [String] For ovirt, vmware datacenter
|
432
|
+
|
433
|
+
</li>
|
434
|
+
</ul>
|
402
435
|
</div>
|
403
436
|
|
404
437
|
</li>
|
@@ -408,6 +441,25 @@ ec2. ,</p>
|
|
408
441
|
|
409
442
|
|
410
443
|
|
444
|
+
<p class="tag_title">Returns:</p>
|
445
|
+
<ul class="return">
|
446
|
+
|
447
|
+
<li>
|
448
|
+
|
449
|
+
|
450
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
—
|
455
|
+
<div class='inline'><p>
|
456
|
+
First item: parsed data; second item: raw body
|
457
|
+
</p>
|
458
|
+
</div>
|
459
|
+
|
460
|
+
</li>
|
461
|
+
|
462
|
+
</ul>
|
411
463
|
|
412
464
|
</div><table class="source_code">
|
413
465
|
<tr>
|
@@ -415,20 +467,17 @@ ec2. ,</p>
|
|
415
467
|
<pre class="lines">
|
416
468
|
|
417
469
|
|
470
|
+
45
|
418
471
|
46
|
419
|
-
47
|
420
|
-
48
|
421
|
-
49
|
422
|
-
50</pre>
|
472
|
+
47</pre>
|
423
473
|
</td>
|
424
474
|
<td>
|
425
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line
|
475
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line 45</span>
|
426
476
|
|
427
|
-
<span class='kw'>def</span> <span class='
|
428
|
-
<span class='
|
429
|
-
|
430
|
-
|
431
|
-
<span class='kw'>end</span></pre>
|
477
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
478
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
479
|
+
<span class='rubyid_end end kw'>end</span>
|
480
|
+
</pre>
|
432
481
|
</td>
|
433
482
|
</tr>
|
434
483
|
</table>
|
@@ -437,7 +486,7 @@ ec2. ,</p>
|
|
437
486
|
<div class="method_details ">
|
438
487
|
<h3 class="signature " id="destroy-instance_method">
|
439
488
|
|
440
|
-
- (<tt>
|
489
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
441
490
|
|
442
491
|
|
443
492
|
|
@@ -445,7 +494,10 @@ ec2. ,</p>
|
|
445
494
|
|
446
495
|
</h3><div class="docstring">
|
447
496
|
<div class="discussion">
|
448
|
-
|
497
|
+
<p>
|
498
|
+
First item: parsed data; second item: raw body
|
499
|
+
</p>
|
500
|
+
|
449
501
|
|
450
502
|
</div>
|
451
503
|
</div>
|
@@ -461,12 +513,13 @@ ec2. ,</p>
|
|
461
513
|
<span class='type'>(<tt>Hash</tt>)</span>
|
462
514
|
|
463
515
|
|
464
|
-
<em class="default">(defaults to: <tt>{
|
516
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
465
517
|
|
466
518
|
|
467
519
|
—
|
468
|
-
<div class='inline'>
|
469
|
-
|
520
|
+
<div class='inline'><p>
|
521
|
+
a hash of params to be passed to the service
|
522
|
+
</p>
|
470
523
|
</div>
|
471
524
|
|
472
525
|
</li>
|
@@ -479,12 +532,13 @@ ec2. ,</p>
|
|
479
532
|
<span class='type'>(<tt>Hash</tt>)</span>
|
480
533
|
|
481
534
|
|
482
|
-
<em class="default">(defaults to: <tt>{
|
535
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
483
536
|
|
484
537
|
|
485
538
|
—
|
486
|
-
<div class='inline'>
|
487
|
-
|
539
|
+
<div class='inline'><p>
|
540
|
+
additional http headers
|
541
|
+
</p>
|
488
542
|
</div>
|
489
543
|
|
490
544
|
</li>
|
@@ -511,6 +565,25 @@ ec2. ,</p>
|
|
511
565
|
|
512
566
|
|
513
567
|
|
568
|
+
<p class="tag_title">Returns:</p>
|
569
|
+
<ul class="return">
|
570
|
+
|
571
|
+
<li>
|
572
|
+
|
573
|
+
|
574
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
575
|
+
|
576
|
+
|
577
|
+
|
578
|
+
—
|
579
|
+
<div class='inline'><p>
|
580
|
+
First item: parsed data; second item: raw body
|
581
|
+
</p>
|
582
|
+
</div>
|
583
|
+
|
584
|
+
</li>
|
585
|
+
|
586
|
+
</ul>
|
514
587
|
|
515
588
|
</div><table class="source_code">
|
516
589
|
<tr>
|
@@ -518,20 +591,17 @@ ec2. ,</p>
|
|
518
591
|
<pre class="lines">
|
519
592
|
|
520
593
|
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
81
|
525
|
-
82</pre>
|
594
|
+
75
|
595
|
+
76
|
596
|
+
77</pre>
|
526
597
|
</td>
|
527
598
|
<td>
|
528
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line
|
599
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line 75</span>
|
529
600
|
|
530
|
-
<span class='kw'>def</span> <span class='
|
531
|
-
<span class='
|
532
|
-
|
533
|
-
|
534
|
-
<span class='kw'>end</span></pre>
|
601
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
602
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
603
|
+
<span class='rubyid_end end kw'>end</span>
|
604
|
+
</pre>
|
535
605
|
</td>
|
536
606
|
</tr>
|
537
607
|
</table>
|
@@ -540,7 +610,7 @@ ec2. ,</p>
|
|
540
610
|
<div class="method_details ">
|
541
611
|
<h3 class="signature " id="index-instance_method">
|
542
612
|
|
543
|
-
- (<tt>
|
613
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
544
614
|
|
545
615
|
|
546
616
|
|
@@ -548,7 +618,10 @@ ec2. ,</p>
|
|
548
618
|
|
549
619
|
</h3><div class="docstring">
|
550
620
|
<div class="discussion">
|
551
|
-
|
621
|
+
<p>
|
622
|
+
First item: parsed data; second item: raw body
|
623
|
+
</p>
|
624
|
+
|
552
625
|
|
553
626
|
</div>
|
554
627
|
</div>
|
@@ -564,12 +637,13 @@ ec2. ,</p>
|
|
564
637
|
<span class='type'>(<tt>Hash</tt>)</span>
|
565
638
|
|
566
639
|
|
567
|
-
<em class="default">(defaults to: <tt>{
|
640
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
568
641
|
|
569
642
|
|
570
643
|
—
|
571
|
-
<div class='inline'>
|
572
|
-
|
644
|
+
<div class='inline'><p>
|
645
|
+
a hash of params to be passed to the service
|
646
|
+
</p>
|
573
647
|
</div>
|
574
648
|
|
575
649
|
</li>
|
@@ -582,12 +656,13 @@ ec2. ,</p>
|
|
582
656
|
<span class='type'>(<tt>Hash</tt>)</span>
|
583
657
|
|
584
658
|
|
585
|
-
<em class="default">(defaults to: <tt>{
|
659
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
586
660
|
|
587
661
|
|
588
662
|
—
|
589
|
-
<div class='inline'>
|
590
|
-
|
663
|
+
<div class='inline'><p>
|
664
|
+
additional http headers
|
665
|
+
</p>
|
591
666
|
</div>
|
592
667
|
|
593
668
|
</li>
|
@@ -607,8 +682,9 @@ ec2. ,</p>
|
|
607
682
|
|
608
683
|
</span>
|
609
684
|
|
610
|
-
— <div class='inline'>
|
611
|
-
|
685
|
+
— <div class='inline'><p>
|
686
|
+
Sort results
|
687
|
+
</p>
|
612
688
|
</div>
|
613
689
|
|
614
690
|
</li>
|
@@ -620,8 +696,9 @@ ec2. ,</p>
|
|
620
696
|
|
621
697
|
</span>
|
622
698
|
|
623
|
-
— <div class='inline'>
|
624
|
-
|
699
|
+
— <div class='inline'><p>
|
700
|
+
Paginate results
|
701
|
+
</p>
|
625
702
|
</div>
|
626
703
|
|
627
704
|
</li>
|
@@ -633,8 +710,9 @@ ec2. ,</p>
|
|
633
710
|
|
634
711
|
</span>
|
635
712
|
|
636
|
-
— <div class='inline'>
|
637
|
-
|
713
|
+
— <div class='inline'><p>
|
714
|
+
Number of entries per request
|
715
|
+
</p>
|
638
716
|
</div>
|
639
717
|
|
640
718
|
</li>
|
@@ -646,8 +724,9 @@ ec2. ,</p>
|
|
646
724
|
|
647
725
|
</span>
|
648
726
|
|
649
|
-
— <div class='inline'>
|
650
|
-
|
727
|
+
— <div class='inline'><p>
|
728
|
+
Filter results
|
729
|
+
</p>
|
651
730
|
</div>
|
652
731
|
|
653
732
|
</li>
|
@@ -657,6 +736,25 @@ ec2. ,</p>
|
|
657
736
|
|
658
737
|
|
659
738
|
|
739
|
+
<p class="tag_title">Returns:</p>
|
740
|
+
<ul class="return">
|
741
|
+
|
742
|
+
<li>
|
743
|
+
|
744
|
+
|
745
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
746
|
+
|
747
|
+
|
748
|
+
|
749
|
+
—
|
750
|
+
<div class='inline'><p>
|
751
|
+
First item: parsed data; second item: raw body
|
752
|
+
</p>
|
753
|
+
</div>
|
754
|
+
|
755
|
+
</li>
|
756
|
+
|
757
|
+
</ul>
|
660
758
|
|
661
759
|
</div><table class="source_code">
|
662
760
|
<tr>
|
@@ -664,20 +762,17 @@ ec2. ,</p>
|
|
664
762
|
<pre class="lines">
|
665
763
|
|
666
764
|
|
667
|
-
15
|
668
765
|
16
|
669
766
|
17
|
670
|
-
18
|
671
|
-
19</pre>
|
767
|
+
18</pre>
|
672
768
|
</td>
|
673
769
|
<td>
|
674
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line
|
770
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line 16</span>
|
675
771
|
|
676
|
-
<span class='kw'>def</span> <span class='
|
677
|
-
<span class='
|
678
|
-
|
679
|
-
|
680
|
-
<span class='kw'>end</span></pre>
|
772
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
773
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
774
|
+
<span class='rubyid_end end kw'>end</span>
|
775
|
+
</pre>
|
681
776
|
</td>
|
682
777
|
</tr>
|
683
778
|
</table>
|
@@ -686,7 +781,7 @@ ec2. ,</p>
|
|
686
781
|
<div class="method_details ">
|
687
782
|
<h3 class="signature " id="show-instance_method">
|
688
783
|
|
689
|
-
- (<tt>
|
784
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
690
785
|
|
691
786
|
|
692
787
|
|
@@ -694,7 +789,10 @@ ec2. ,</p>
|
|
694
789
|
|
695
790
|
</h3><div class="docstring">
|
696
791
|
<div class="discussion">
|
697
|
-
|
792
|
+
<p>
|
793
|
+
First item: parsed data; second item: raw body
|
794
|
+
</p>
|
795
|
+
|
698
796
|
|
699
797
|
</div>
|
700
798
|
</div>
|
@@ -710,12 +808,13 @@ ec2. ,</p>
|
|
710
808
|
<span class='type'>(<tt>Hash</tt>)</span>
|
711
809
|
|
712
810
|
|
713
|
-
<em class="default">(defaults to: <tt>{
|
811
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
714
812
|
|
715
813
|
|
716
814
|
—
|
717
|
-
<div class='inline'>
|
718
|
-
|
815
|
+
<div class='inline'><p>
|
816
|
+
a hash of params to be passed to the service
|
817
|
+
</p>
|
719
818
|
</div>
|
720
819
|
|
721
820
|
</li>
|
@@ -728,12 +827,13 @@ ec2. ,</p>
|
|
728
827
|
<span class='type'>(<tt>Hash</tt>)</span>
|
729
828
|
|
730
829
|
|
731
|
-
<em class="default">(defaults to: <tt>{
|
830
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
732
831
|
|
733
832
|
|
734
833
|
—
|
735
|
-
<div class='inline'>
|
736
|
-
|
834
|
+
<div class='inline'><p>
|
835
|
+
additional http headers
|
836
|
+
</p>
|
737
837
|
</div>
|
738
838
|
|
739
839
|
</li>
|
@@ -760,6 +860,25 @@ ec2. ,</p>
|
|
760
860
|
|
761
861
|
|
762
862
|
|
863
|
+
<p class="tag_title">Returns:</p>
|
864
|
+
<ul class="return">
|
865
|
+
|
866
|
+
<li>
|
867
|
+
|
868
|
+
|
869
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
—
|
874
|
+
<div class='inline'><p>
|
875
|
+
First item: parsed data; second item: raw body
|
876
|
+
</p>
|
877
|
+
</div>
|
878
|
+
|
879
|
+
</li>
|
880
|
+
|
881
|
+
</ul>
|
763
882
|
|
764
883
|
</div><table class="source_code">
|
765
884
|
<tr>
|
@@ -769,18 +888,15 @@ ec2. ,</p>
|
|
769
888
|
|
770
889
|
25
|
771
890
|
26
|
772
|
-
27
|
773
|
-
28
|
774
|
-
29</pre>
|
891
|
+
27</pre>
|
775
892
|
</td>
|
776
893
|
<td>
|
777
894
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line 25</span>
|
778
895
|
|
779
|
-
<span class='kw'>def</span> <span class='
|
780
|
-
<span class='
|
781
|
-
|
782
|
-
|
783
|
-
<span class='kw'>end</span></pre>
|
896
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
897
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
898
|
+
<span class='rubyid_end end kw'>end</span>
|
899
|
+
</pre>
|
784
900
|
</td>
|
785
901
|
</tr>
|
786
902
|
</table>
|
@@ -789,7 +905,7 @@ ec2. ,</p>
|
|
789
905
|
<div class="method_details ">
|
790
906
|
<h3 class="signature " id="update-instance_method">
|
791
907
|
|
792
|
-
- (<tt>
|
908
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
793
909
|
|
794
910
|
|
795
911
|
|
@@ -797,7 +913,10 @@ ec2. ,</p>
|
|
797
913
|
|
798
914
|
</h3><div class="docstring">
|
799
915
|
<div class="discussion">
|
800
|
-
|
916
|
+
<p>
|
917
|
+
First item: parsed data; second item: raw body
|
918
|
+
</p>
|
919
|
+
|
801
920
|
|
802
921
|
</div>
|
803
922
|
</div>
|
@@ -813,12 +932,13 @@ ec2. ,</p>
|
|
813
932
|
<span class='type'>(<tt>Hash</tt>)</span>
|
814
933
|
|
815
934
|
|
816
|
-
<em class="default">(defaults to: <tt>{
|
935
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
817
936
|
|
818
937
|
|
819
938
|
—
|
820
|
-
<div class='inline'>
|
821
|
-
|
939
|
+
<div class='inline'><p>
|
940
|
+
a hash of params to be passed to the service
|
941
|
+
</p>
|
822
942
|
</div>
|
823
943
|
|
824
944
|
</li>
|
@@ -831,12 +951,13 @@ ec2. ,</p>
|
|
831
951
|
<span class='type'>(<tt>Hash</tt>)</span>
|
832
952
|
|
833
953
|
|
834
|
-
<em class="default">(defaults to: <tt>{
|
954
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
835
955
|
|
836
956
|
|
837
957
|
—
|
838
|
-
<div class='inline'>
|
839
|
-
|
958
|
+
<div class='inline'><p>
|
959
|
+
additional http headers
|
960
|
+
</p>
|
840
961
|
</div>
|
841
962
|
|
842
963
|
</li>
|
@@ -865,32 +986,44 @@ ec2. ,</p>
|
|
865
986
|
|
866
987
|
</span>
|
867
988
|
|
868
|
-
— <div class='inline'>
|
869
|
-
|
870
|
-
|
871
|
-
<
|
872
|
-
|
873
|
-
|
874
|
-
</li
|
875
|
-
<
|
876
|
-
|
877
|
-
</li
|
878
|
-
<
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
|
887
|
-
|
888
|
-
</li
|
889
|
-
<
|
890
|
-
|
891
|
-
</li
|
892
|
-
<
|
893
|
-
|
989
|
+
— <div class='inline'><p>
|
990
|
+
allowed keys are:
|
991
|
+
</p>
|
992
|
+
<ul>
|
993
|
+
<li>description [String]
|
994
|
+
|
995
|
+
</li>
|
996
|
+
<li>name [String]
|
997
|
+
|
998
|
+
</li>
|
999
|
+
<li>password [String] Password for ovirt, ec2, vmware, openstack. secret key
|
1000
|
+
for ec2
|
1001
|
+
|
1002
|
+
</li>
|
1003
|
+
<li>provider [String] Providers include libvirt, ovirt, ec2, vmware, openstack,
|
1004
|
+
rackspace
|
1005
|
+
|
1006
|
+
</li>
|
1007
|
+
<li>region [String] For ec2 only
|
1008
|
+
|
1009
|
+
</li>
|
1010
|
+
<li>server [String] For vmware
|
1011
|
+
|
1012
|
+
</li>
|
1013
|
+
<li>tenant [String] For openstack only
|
1014
|
+
|
1015
|
+
</li>
|
1016
|
+
<li>url [String] Url for libvirt, ovirt, and openstack
|
1017
|
+
|
1018
|
+
</li>
|
1019
|
+
<li>user [String] Username for ovirt, ec2, vmware, openstack. access key for
|
1020
|
+
ec2.
|
1021
|
+
|
1022
|
+
</li>
|
1023
|
+
<li>uuid [String] For ovirt, vmware datacenter
|
1024
|
+
|
1025
|
+
</li>
|
1026
|
+
</ul>
|
894
1027
|
</div>
|
895
1028
|
|
896
1029
|
</li>
|
@@ -900,6 +1033,25 @@ ec2. ,</p>
|
|
900
1033
|
|
901
1034
|
|
902
1035
|
|
1036
|
+
<p class="tag_title">Returns:</p>
|
1037
|
+
<ul class="return">
|
1038
|
+
|
1039
|
+
<li>
|
1040
|
+
|
1041
|
+
|
1042
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1043
|
+
|
1044
|
+
|
1045
|
+
|
1046
|
+
—
|
1047
|
+
<div class='inline'><p>
|
1048
|
+
First item: parsed data; second item: raw body
|
1049
|
+
</p>
|
1050
|
+
</div>
|
1051
|
+
|
1052
|
+
</li>
|
1053
|
+
|
1054
|
+
</ul>
|
903
1055
|
|
904
1056
|
</div><table class="source_code">
|
905
1057
|
<tr>
|
@@ -907,20 +1059,17 @@ ec2. ,</p>
|
|
907
1059
|
<pre class="lines">
|
908
1060
|
|
909
1061
|
|
910
|
-
|
911
|
-
|
912
|
-
|
913
|
-
71
|
914
|
-
72</pre>
|
1062
|
+
66
|
1063
|
+
67
|
1064
|
+
68</pre>
|
915
1065
|
</td>
|
916
1066
|
<td>
|
917
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line
|
1067
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/compute_resource.rb', line 66</span>
|
918
1068
|
|
919
|
-
<span class='kw'>def</span> <span class='
|
920
|
-
<span class='
|
921
|
-
|
922
|
-
|
923
|
-
<span class='kw'>end</span></pre>
|
1069
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
1070
|
+
<span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
|
1071
|
+
<span class='rubyid_end end kw'>end</span>
|
1072
|
+
</pre>
|
924
1073
|
</td>
|
925
1074
|
</tr>
|
926
1075
|
</table>
|
@@ -931,9 +1080,9 @@ ec2. ,</p>
|
|
931
1080
|
</div>
|
932
1081
|
|
933
1082
|
<div id="footer">
|
934
|
-
Generated on
|
1083
|
+
Generated on Tue Mar 19 09:50:28 2013 by
|
935
1084
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
936
|
-
0.8.
|
1085
|
+
0.8.5.2 (ruby-1.8.7).
|
937
1086
|
</div>
|
938
1087
|
|
939
1088
|
</body>
|