foreman_api 0.1.3 → 0.1.4
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/README.rdoc +35 -18
- data/doc/ForemanApi/Resources/Architecture.html +93 -136
- data/doc/ForemanApi/Resources/Audit.html +42 -60
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +129 -190
- data/doc/ForemanApi/Resources/Bookmark.html +97 -142
- data/doc/ForemanApi/Resources/CommonParameter.html +93 -136
- data/doc/ForemanApi/Resources/ComputeResource.html +131 -190
- data/doc/ForemanApi/Resources/ConfigTemplate.html +145 -211
- data/doc/ForemanApi/Resources/Dashboard.html +21 -29
- data/doc/ForemanApi/Resources/Domain.html +103 -151
- data/doc/ForemanApi/Resources/Environment.html +89 -130
- data/doc/ForemanApi/Resources/FactValue.html +29 -41
- data/doc/ForemanApi/Resources/Home.html +32 -45
- data/doc/ForemanApi/Resources/Host.html +317 -251
- data/doc/ForemanApi/Resources/HostClass.html +55 -79
- data/doc/ForemanApi/Resources/Hostgroup.html +125 -184
- data/doc/ForemanApi/Resources/HostgroupClass.html +57 -82
- data/doc/ForemanApi/Resources/Image.html +109 -160
- data/doc/ForemanApi/Resources/Location.html +937 -0
- data/doc/ForemanApi/Resources/LookupKey.html +111 -163
- data/doc/ForemanApi/Resources/Medium.html +113 -154
- data/doc/ForemanApi/Resources/Model.html +101 -148
- data/doc/ForemanApi/Resources/OperatingSystem.html +118 -173
- data/doc/ForemanApi/Resources/Organization.html +937 -0
- data/doc/ForemanApi/Resources/Parameter.html +158 -233
- data/doc/ForemanApi/Resources/Ptable.html +97 -142
- data/doc/ForemanApi/Resources/Puppetclass.html +95 -139
- data/doc/ForemanApi/Resources/Report.html +68 -98
- data/doc/ForemanApi/Resources/Role.html +85 -124
- data/doc/ForemanApi/Resources/Setting.html +58 -84
- data/doc/ForemanApi/Resources/SmartProxy.html +91 -133
- data/doc/ForemanApi/Resources/Subnet.html +141 -208
- data/doc/ForemanApi/Resources/TemplateCombination.html +65 -94
- data/doc/ForemanApi/Resources/TemplateKind.html +23 -32
- data/doc/ForemanApi/Resources/User.html +111 -163
- data/doc/ForemanApi/Resources/Usergroup.html +89 -130
- data/doc/ForemanApi/Resources.html +6 -6
- data/doc/ForemanApi.html +5 -5
- data/doc/_index.html +18 -4
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +0 -10
- data/doc/file.MIT-LICENSE.html +24 -29
- data/doc/file.README.html +81 -60
- data/doc/frames.html +1 -1
- data/doc/index.html +81 -60
- data/doc/method_list.html +416 -312
- data/doc/top-level-namespace.html +3 -3
- data/lib/foreman_api/base.rb +16 -8
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/host.rb +9 -0
- data/lib/foreman_api/resources/location.rb +59 -0
- data/lib/foreman_api/resources/medium.rb +2 -2
- data/lib/foreman_api/resources/organization.rb +59 -0
- data/lib/foreman_api/version.rb +1 -1
- metadata +7 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: ForemanApi::Resources::Parameter
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.8.
|
|
9
|
+
— Documentation by YARD 0.8.3
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -164,9 +164,8 @@
|
|
|
164
164
|
|
|
165
165
|
|
|
166
166
|
|
|
167
|
-
<span class="summary_desc"><div class='inline'
|
|
168
|
-
First item: parsed data; second item: raw body
|
|
169
|
-
</p>
|
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
|
168
|
+
<p>First item: parsed data; second item: raw body.</p>
|
|
170
169
|
</div></span>
|
|
171
170
|
|
|
172
171
|
</li>
|
|
@@ -189,9 +188,8 @@ First item: parsed data; second item: raw body.
|
|
|
189
188
|
|
|
190
189
|
|
|
191
190
|
|
|
192
|
-
<span class="summary_desc"><div class='inline'
|
|
193
|
-
First item: parsed data; second item: raw body
|
|
194
|
-
</p>
|
|
191
|
+
<span class="summary_desc"><div class='inline'>
|
|
192
|
+
<p>First item: parsed data; second item: raw body.</p>
|
|
195
193
|
</div></span>
|
|
196
194
|
|
|
197
195
|
</li>
|
|
@@ -214,9 +212,8 @@ First item: parsed data; second item: raw body.
|
|
|
214
212
|
|
|
215
213
|
|
|
216
214
|
|
|
217
|
-
<span class="summary_desc"><div class='inline'
|
|
218
|
-
First item: parsed data; second item: raw body
|
|
219
|
-
</p>
|
|
215
|
+
<span class="summary_desc"><div class='inline'>
|
|
216
|
+
<p>First item: parsed data; second item: raw body.</p>
|
|
220
217
|
</div></span>
|
|
221
218
|
|
|
222
219
|
</li>
|
|
@@ -239,9 +236,8 @@ First item: parsed data; second item: raw body.
|
|
|
239
236
|
|
|
240
237
|
|
|
241
238
|
|
|
242
|
-
<span class="summary_desc"><div class='inline'
|
|
243
|
-
First item: parsed data; second item: raw body
|
|
244
|
-
</p>
|
|
239
|
+
<span class="summary_desc"><div class='inline'>
|
|
240
|
+
<p>First item: parsed data; second item: raw body.</p>
|
|
245
241
|
</div></span>
|
|
246
242
|
|
|
247
243
|
</li>
|
|
@@ -264,9 +260,8 @@ First item: parsed data; second item: raw body.
|
|
|
264
260
|
|
|
265
261
|
|
|
266
262
|
|
|
267
|
-
<span class="summary_desc"><div class='inline'
|
|
268
|
-
First item: parsed data; second item: raw body
|
|
269
|
-
</p>
|
|
263
|
+
<span class="summary_desc"><div class='inline'>
|
|
264
|
+
<p>First item: parsed data; second item: raw body.</p>
|
|
270
265
|
</div></span>
|
|
271
266
|
|
|
272
267
|
</li>
|
|
@@ -289,9 +284,8 @@ First item: parsed data; second item: raw body.
|
|
|
289
284
|
|
|
290
285
|
|
|
291
286
|
|
|
292
|
-
<span class="summary_desc"><div class='inline'
|
|
293
|
-
First item: parsed data; second item: raw body
|
|
294
|
-
</p>
|
|
287
|
+
<span class="summary_desc"><div class='inline'>
|
|
288
|
+
<p>First item: parsed data; second item: raw body.</p>
|
|
295
289
|
</div></span>
|
|
296
290
|
|
|
297
291
|
</li>
|
|
@@ -329,10 +323,9 @@ First item: parsed data; second item: raw body.
|
|
|
329
323
|
<td>
|
|
330
324
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 4</span>
|
|
331
325
|
|
|
332
|
-
<span class='
|
|
333
|
-
<span class='
|
|
334
|
-
<span class='
|
|
335
|
-
</pre>
|
|
326
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
|
|
327
|
+
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>parameters</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
328
|
+
<span class='kw'>end</span></pre>
|
|
336
329
|
</td>
|
|
337
330
|
</tr>
|
|
338
331
|
</table>
|
|
@@ -355,9 +348,8 @@ First item: parsed data; second item: raw body.
|
|
|
355
348
|
|
|
356
349
|
</h3><div class="docstring">
|
|
357
350
|
<div class="discussion">
|
|
358
|
-
|
|
359
|
-
First item: parsed data; second item: raw body
|
|
360
|
-
</p>
|
|
351
|
+
|
|
352
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
361
353
|
|
|
362
354
|
|
|
363
355
|
</div>
|
|
@@ -378,9 +370,8 @@ First item: parsed data; second item: raw body
|
|
|
378
370
|
|
|
379
371
|
|
|
380
372
|
—
|
|
381
|
-
<div class='inline'
|
|
382
|
-
a hash of params to be passed to the service
|
|
383
|
-
</p>
|
|
373
|
+
<div class='inline'>
|
|
374
|
+
<p>a hash of params to be passed to the service</p>
|
|
384
375
|
</div>
|
|
385
376
|
|
|
386
377
|
</li>
|
|
@@ -397,9 +388,8 @@ a hash of params to be passed to the service
|
|
|
397
388
|
|
|
398
389
|
|
|
399
390
|
—
|
|
400
|
-
<div class='inline'
|
|
401
|
-
additional http headers
|
|
402
|
-
</p>
|
|
391
|
+
<div class='inline'>
|
|
392
|
+
<p>additional http headers</p>
|
|
403
393
|
</div>
|
|
404
394
|
|
|
405
395
|
</li>
|
|
@@ -419,9 +409,8 @@ additional http headers
|
|
|
419
409
|
|
|
420
410
|
</span>
|
|
421
411
|
|
|
422
|
-
— <div class='inline'
|
|
423
|
-
Id of parameter
|
|
424
|
-
</p>
|
|
412
|
+
— <div class='inline'>
|
|
413
|
+
<p>Id of parameter</p>
|
|
425
414
|
</div>
|
|
426
415
|
|
|
427
416
|
</li>
|
|
@@ -433,9 +422,8 @@ Id of parameter
|
|
|
433
422
|
|
|
434
423
|
</span>
|
|
435
424
|
|
|
436
|
-
— <div class='inline'
|
|
437
|
-
Id of domain
|
|
438
|
-
</p>
|
|
425
|
+
— <div class='inline'>
|
|
426
|
+
<p>Id of domain</p>
|
|
439
427
|
</div>
|
|
440
428
|
|
|
441
429
|
</li>
|
|
@@ -447,9 +435,8 @@ Id of domain
|
|
|
447
435
|
|
|
448
436
|
</span>
|
|
449
437
|
|
|
450
|
-
— <div class='inline'
|
|
451
|
-
Id of host
|
|
452
|
-
</p>
|
|
438
|
+
— <div class='inline'>
|
|
439
|
+
<p>Id of host</p>
|
|
453
440
|
</div>
|
|
454
441
|
|
|
455
442
|
</li>
|
|
@@ -461,9 +448,8 @@ Id of host
|
|
|
461
448
|
|
|
462
449
|
</span>
|
|
463
450
|
|
|
464
|
-
— <div class='inline'
|
|
465
|
-
Id of hostgroup
|
|
466
|
-
</p>
|
|
451
|
+
— <div class='inline'>
|
|
452
|
+
<p>Id of hostgroup</p>
|
|
467
453
|
</div>
|
|
468
454
|
|
|
469
455
|
</li>
|
|
@@ -475,9 +461,8 @@ Id of hostgroup
|
|
|
475
461
|
|
|
476
462
|
</span>
|
|
477
463
|
|
|
478
|
-
— <div class='inline'
|
|
479
|
-
Id of operating system
|
|
480
|
-
</p>
|
|
464
|
+
— <div class='inline'>
|
|
465
|
+
<p>Id of operating system</p>
|
|
481
466
|
</div>
|
|
482
467
|
|
|
483
468
|
</li>
|
|
@@ -489,17 +474,13 @@ Id of operating system
|
|
|
489
474
|
|
|
490
475
|
</span>
|
|
491
476
|
|
|
492
|
-
— <div class='inline'
|
|
493
|
-
allowed keys are
|
|
494
|
-
|
|
495
|
-
<
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
</li>
|
|
499
|
-
<li>value [String]
|
|
500
|
-
|
|
501
|
-
</li>
|
|
502
|
-
</ul>
|
|
477
|
+
— <div class='inline'>
|
|
478
|
+
<p>allowed keys are:</p>
|
|
479
|
+
<ul><li>
|
|
480
|
+
<p>name [String]</p>
|
|
481
|
+
</li><li>
|
|
482
|
+
<p>value [String]</p>
|
|
483
|
+
</li></ul>
|
|
503
484
|
</div>
|
|
504
485
|
|
|
505
486
|
</li>
|
|
@@ -520,9 +501,8 @@ allowed keys are:
|
|
|
520
501
|
|
|
521
502
|
|
|
522
503
|
—
|
|
523
|
-
<div class='inline'
|
|
524
|
-
First item: parsed data; second item: raw body
|
|
525
|
-
</p>
|
|
504
|
+
<div class='inline'>
|
|
505
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
526
506
|
</div>
|
|
527
507
|
|
|
528
508
|
</li>
|
|
@@ -542,10 +522,9 @@ First item: parsed data; second item: raw body
|
|
|
542
522
|
<td>
|
|
543
523
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 48</span>
|
|
544
524
|
|
|
545
|
-
<span class='
|
|
546
|
-
<span class='
|
|
547
|
-
<span class='
|
|
548
|
-
</pre>
|
|
525
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
526
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
527
|
+
<span class='kw'>end</span></pre>
|
|
549
528
|
</td>
|
|
550
529
|
</tr>
|
|
551
530
|
</table>
|
|
@@ -562,9 +541,8 @@ First item: parsed data; second item: raw body
|
|
|
562
541
|
|
|
563
542
|
</h3><div class="docstring">
|
|
564
543
|
<div class="discussion">
|
|
565
|
-
|
|
566
|
-
First item: parsed data; second item: raw body
|
|
567
|
-
</p>
|
|
544
|
+
|
|
545
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
568
546
|
|
|
569
547
|
|
|
570
548
|
</div>
|
|
@@ -585,9 +563,8 @@ First item: parsed data; second item: raw body
|
|
|
585
563
|
|
|
586
564
|
|
|
587
565
|
—
|
|
588
|
-
<div class='inline'
|
|
589
|
-
a hash of params to be passed to the service
|
|
590
|
-
</p>
|
|
566
|
+
<div class='inline'>
|
|
567
|
+
<p>a hash of params to be passed to the service</p>
|
|
591
568
|
</div>
|
|
592
569
|
|
|
593
570
|
</li>
|
|
@@ -604,9 +581,8 @@ a hash of params to be passed to the service
|
|
|
604
581
|
|
|
605
582
|
|
|
606
583
|
—
|
|
607
|
-
<div class='inline'
|
|
608
|
-
additional http headers
|
|
609
|
-
</p>
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>additional http headers</p>
|
|
610
586
|
</div>
|
|
611
587
|
|
|
612
588
|
</li>
|
|
@@ -626,9 +602,8 @@ additional http headers
|
|
|
626
602
|
|
|
627
603
|
</span>
|
|
628
604
|
|
|
629
|
-
— <div class='inline'
|
|
630
|
-
Id of parameter
|
|
631
|
-
</p>
|
|
605
|
+
— <div class='inline'>
|
|
606
|
+
<p>Id of parameter</p>
|
|
632
607
|
</div>
|
|
633
608
|
|
|
634
609
|
</li>
|
|
@@ -640,9 +615,8 @@ Id of parameter
|
|
|
640
615
|
|
|
641
616
|
</span>
|
|
642
617
|
|
|
643
|
-
— <div class='inline'
|
|
644
|
-
Id of domain
|
|
645
|
-
</p>
|
|
618
|
+
— <div class='inline'>
|
|
619
|
+
<p>Id of domain</p>
|
|
646
620
|
</div>
|
|
647
621
|
|
|
648
622
|
</li>
|
|
@@ -654,9 +628,8 @@ Id of domain
|
|
|
654
628
|
|
|
655
629
|
</span>
|
|
656
630
|
|
|
657
|
-
— <div class='inline'
|
|
658
|
-
Id of host
|
|
659
|
-
</p>
|
|
631
|
+
— <div class='inline'>
|
|
632
|
+
<p>Id of host</p>
|
|
660
633
|
</div>
|
|
661
634
|
|
|
662
635
|
</li>
|
|
@@ -668,9 +641,8 @@ Id of host
|
|
|
668
641
|
|
|
669
642
|
</span>
|
|
670
643
|
|
|
671
|
-
— <div class='inline'
|
|
672
|
-
Id of hostgroup
|
|
673
|
-
</p>
|
|
644
|
+
— <div class='inline'>
|
|
645
|
+
<p>Id of hostgroup</p>
|
|
674
646
|
</div>
|
|
675
647
|
|
|
676
648
|
</li>
|
|
@@ -682,9 +654,8 @@ Id of hostgroup
|
|
|
682
654
|
|
|
683
655
|
</span>
|
|
684
656
|
|
|
685
|
-
— <div class='inline'
|
|
686
|
-
Id of operating system
|
|
687
|
-
</p>
|
|
657
|
+
— <div class='inline'>
|
|
658
|
+
<p>Id of operating system</p>
|
|
688
659
|
</div>
|
|
689
660
|
|
|
690
661
|
</li>
|
|
@@ -705,9 +676,8 @@ Id of operating system
|
|
|
705
676
|
|
|
706
677
|
|
|
707
678
|
—
|
|
708
|
-
<div class='inline'
|
|
709
|
-
First item: parsed data; second item: raw body
|
|
710
|
-
</p>
|
|
679
|
+
<div class='inline'>
|
|
680
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
711
681
|
</div>
|
|
712
682
|
|
|
713
683
|
</li>
|
|
@@ -727,10 +697,9 @@ First item: parsed data; second item: raw body
|
|
|
727
697
|
<td>
|
|
728
698
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 78</span>
|
|
729
699
|
|
|
730
|
-
<span class='
|
|
731
|
-
<span class='
|
|
732
|
-
<span class='
|
|
733
|
-
</pre>
|
|
700
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
701
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
702
|
+
<span class='kw'>end</span></pre>
|
|
734
703
|
</td>
|
|
735
704
|
</tr>
|
|
736
705
|
</table>
|
|
@@ -747,9 +716,8 @@ First item: parsed data; second item: raw body
|
|
|
747
716
|
|
|
748
717
|
</h3><div class="docstring">
|
|
749
718
|
<div class="discussion">
|
|
750
|
-
|
|
751
|
-
First item: parsed data; second item: raw body
|
|
752
|
-
</p>
|
|
719
|
+
|
|
720
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
753
721
|
|
|
754
722
|
|
|
755
723
|
</div>
|
|
@@ -770,9 +738,8 @@ First item: parsed data; second item: raw body
|
|
|
770
738
|
|
|
771
739
|
|
|
772
740
|
—
|
|
773
|
-
<div class='inline'
|
|
774
|
-
a hash of params to be passed to the service
|
|
775
|
-
</p>
|
|
741
|
+
<div class='inline'>
|
|
742
|
+
<p>a hash of params to be passed to the service</p>
|
|
776
743
|
</div>
|
|
777
744
|
|
|
778
745
|
</li>
|
|
@@ -789,9 +756,8 @@ a hash of params to be passed to the service
|
|
|
789
756
|
|
|
790
757
|
|
|
791
758
|
—
|
|
792
|
-
<div class='inline'
|
|
793
|
-
additional http headers
|
|
794
|
-
</p>
|
|
759
|
+
<div class='inline'>
|
|
760
|
+
<p>additional http headers</p>
|
|
795
761
|
</div>
|
|
796
762
|
|
|
797
763
|
</li>
|
|
@@ -811,9 +777,8 @@ additional http headers
|
|
|
811
777
|
|
|
812
778
|
</span>
|
|
813
779
|
|
|
814
|
-
— <div class='inline'
|
|
815
|
-
Id of domain
|
|
816
|
-
</p>
|
|
780
|
+
— <div class='inline'>
|
|
781
|
+
<p>Id of domain</p>
|
|
817
782
|
</div>
|
|
818
783
|
|
|
819
784
|
</li>
|
|
@@ -825,9 +790,8 @@ Id of domain
|
|
|
825
790
|
|
|
826
791
|
</span>
|
|
827
792
|
|
|
828
|
-
— <div class='inline'
|
|
829
|
-
Id of host
|
|
830
|
-
</p>
|
|
793
|
+
— <div class='inline'>
|
|
794
|
+
<p>Id of host</p>
|
|
831
795
|
</div>
|
|
832
796
|
|
|
833
797
|
</li>
|
|
@@ -839,9 +803,8 @@ Id of host
|
|
|
839
803
|
|
|
840
804
|
</span>
|
|
841
805
|
|
|
842
|
-
— <div class='inline'
|
|
843
|
-
Id of hostgroup
|
|
844
|
-
</p>
|
|
806
|
+
— <div class='inline'>
|
|
807
|
+
<p>Id of hostgroup</p>
|
|
845
808
|
</div>
|
|
846
809
|
|
|
847
810
|
</li>
|
|
@@ -853,9 +816,8 @@ Id of hostgroup
|
|
|
853
816
|
|
|
854
817
|
</span>
|
|
855
818
|
|
|
856
|
-
— <div class='inline'
|
|
857
|
-
Id of operating system
|
|
858
|
-
</p>
|
|
819
|
+
— <div class='inline'>
|
|
820
|
+
<p>Id of operating system</p>
|
|
859
821
|
</div>
|
|
860
822
|
|
|
861
823
|
</li>
|
|
@@ -867,9 +829,8 @@ Id of operating system
|
|
|
867
829
|
|
|
868
830
|
</span>
|
|
869
831
|
|
|
870
|
-
— <div class='inline'
|
|
871
|
-
Paginate results
|
|
872
|
-
</p>
|
|
832
|
+
— <div class='inline'>
|
|
833
|
+
<p>Paginate results</p>
|
|
873
834
|
</div>
|
|
874
835
|
|
|
875
836
|
</li>
|
|
@@ -881,9 +842,8 @@ Paginate results
|
|
|
881
842
|
|
|
882
843
|
</span>
|
|
883
844
|
|
|
884
|
-
— <div class='inline'
|
|
885
|
-
Number of entries per request
|
|
886
|
-
</p>
|
|
845
|
+
— <div class='inline'>
|
|
846
|
+
<p>Number of entries per request</p>
|
|
887
847
|
</div>
|
|
888
848
|
|
|
889
849
|
</li>
|
|
@@ -904,9 +864,8 @@ Number of entries per request
|
|
|
904
864
|
|
|
905
865
|
|
|
906
866
|
—
|
|
907
|
-
<div class='inline'
|
|
908
|
-
First item: parsed data; second item: raw body
|
|
909
|
-
</p>
|
|
867
|
+
<div class='inline'>
|
|
868
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
910
869
|
</div>
|
|
911
870
|
|
|
912
871
|
</li>
|
|
@@ -926,10 +885,9 @@ First item: parsed data; second item: raw body
|
|
|
926
885
|
<td>
|
|
927
886
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 18</span>
|
|
928
887
|
|
|
929
|
-
<span class='
|
|
930
|
-
<span class='
|
|
931
|
-
<span class='
|
|
932
|
-
</pre>
|
|
888
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
889
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
890
|
+
<span class='kw'>end</span></pre>
|
|
933
891
|
</td>
|
|
934
892
|
</tr>
|
|
935
893
|
</table>
|
|
@@ -946,9 +904,8 @@ First item: parsed data; second item: raw body
|
|
|
946
904
|
|
|
947
905
|
</h3><div class="docstring">
|
|
948
906
|
<div class="discussion">
|
|
949
|
-
|
|
950
|
-
First item: parsed data; second item: raw body
|
|
951
|
-
</p>
|
|
907
|
+
|
|
908
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
952
909
|
|
|
953
910
|
|
|
954
911
|
</div>
|
|
@@ -969,9 +926,8 @@ First item: parsed data; second item: raw body
|
|
|
969
926
|
|
|
970
927
|
|
|
971
928
|
—
|
|
972
|
-
<div class='inline'
|
|
973
|
-
a hash of params to be passed to the service
|
|
974
|
-
</p>
|
|
929
|
+
<div class='inline'>
|
|
930
|
+
<p>a hash of params to be passed to the service</p>
|
|
975
931
|
</div>
|
|
976
932
|
|
|
977
933
|
</li>
|
|
@@ -988,9 +944,8 @@ a hash of params to be passed to the service
|
|
|
988
944
|
|
|
989
945
|
|
|
990
946
|
—
|
|
991
|
-
<div class='inline'
|
|
992
|
-
additional http headers
|
|
993
|
-
</p>
|
|
947
|
+
<div class='inline'>
|
|
948
|
+
<p>additional http headers</p>
|
|
994
949
|
</div>
|
|
995
950
|
|
|
996
951
|
</li>
|
|
@@ -1010,9 +965,8 @@ additional http headers
|
|
|
1010
965
|
|
|
1011
966
|
</span>
|
|
1012
967
|
|
|
1013
|
-
— <div class='inline'
|
|
1014
|
-
Part of <tt>/api/domain/:domain_id/parameters</tt> path
|
|
1015
|
-
</p>
|
|
968
|
+
— <div class='inline'>
|
|
969
|
+
<p>Part of <tt>/api/domain/:domain_id/parameters</tt> path</p>
|
|
1016
970
|
</div>
|
|
1017
971
|
|
|
1018
972
|
</li>
|
|
@@ -1024,9 +978,8 @@ Part of <tt>/api/domain/:domain_id/parameters</tt> path
|
|
|
1024
978
|
|
|
1025
979
|
</span>
|
|
1026
980
|
|
|
1027
|
-
— <div class='inline'
|
|
1028
|
-
Part of <tt>/api/host/:host_id/parameters</tt> path
|
|
1029
|
-
</p>
|
|
981
|
+
— <div class='inline'>
|
|
982
|
+
<p>Part of <tt>/api/host/:host_id/parameters</tt> path</p>
|
|
1030
983
|
</div>
|
|
1031
984
|
|
|
1032
985
|
</li>
|
|
@@ -1038,9 +991,8 @@ Part of <tt>/api/host/:host_id/parameters</tt> path
|
|
|
1038
991
|
|
|
1039
992
|
</span>
|
|
1040
993
|
|
|
1041
|
-
— <div class='inline'
|
|
1042
|
-
Part of <tt>/api/hostgroup/:hostgroup_id/parameters</tt> path
|
|
1043
|
-
</p>
|
|
994
|
+
— <div class='inline'>
|
|
995
|
+
<p>Part of <tt>/api/hostgroup/:hostgroup_id/parameters</tt> path</p>
|
|
1044
996
|
</div>
|
|
1045
997
|
|
|
1046
998
|
</li>
|
|
@@ -1052,9 +1004,8 @@ Part of <tt>/api/hostgroup/:hostgroup_id/parameters</tt> path
|
|
|
1052
1004
|
|
|
1053
1005
|
</span>
|
|
1054
1006
|
|
|
1055
|
-
— <div class='inline'
|
|
1056
|
-
Part of <tt>/api/operatingsystem/:operatingsystem_id/parameters</tt> path
|
|
1057
|
-
</p>
|
|
1007
|
+
— <div class='inline'>
|
|
1008
|
+
<p>Part of <tt>/api/operatingsystem/:operatingsystem_id/parameters</tt> path</p>
|
|
1058
1009
|
</div>
|
|
1059
1010
|
|
|
1060
1011
|
</li>
|
|
@@ -1075,9 +1026,8 @@ Part of <tt>/api/operatingsystem/:operatingsystem_id/parameters</tt> path
|
|
|
1075
1026
|
|
|
1076
1027
|
|
|
1077
1028
|
—
|
|
1078
|
-
<div class='inline'
|
|
1079
|
-
First item: parsed data; second item: raw body
|
|
1080
|
-
</p>
|
|
1029
|
+
<div class='inline'>
|
|
1030
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
1081
1031
|
</div>
|
|
1082
1032
|
|
|
1083
1033
|
</li>
|
|
@@ -1097,10 +1047,9 @@ First item: parsed data; second item: raw body
|
|
|
1097
1047
|
<td>
|
|
1098
1048
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 90</span>
|
|
1099
1049
|
|
|
1100
|
-
<span class='
|
|
1101
|
-
<span class='
|
|
1102
|
-
<span class='
|
|
1103
|
-
</pre>
|
|
1050
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1051
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
1052
|
+
<span class='kw'>end</span></pre>
|
|
1104
1053
|
</td>
|
|
1105
1054
|
</tr>
|
|
1106
1055
|
</table>
|
|
@@ -1117,9 +1066,8 @@ First item: parsed data; second item: raw body
|
|
|
1117
1066
|
|
|
1118
1067
|
</h3><div class="docstring">
|
|
1119
1068
|
<div class="discussion">
|
|
1120
|
-
|
|
1121
|
-
First item: parsed data; second item: raw body
|
|
1122
|
-
</p>
|
|
1069
|
+
|
|
1070
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
1123
1071
|
|
|
1124
1072
|
|
|
1125
1073
|
</div>
|
|
@@ -1140,9 +1088,8 @@ First item: parsed data; second item: raw body
|
|
|
1140
1088
|
|
|
1141
1089
|
|
|
1142
1090
|
—
|
|
1143
|
-
<div class='inline'
|
|
1144
|
-
a hash of params to be passed to the service
|
|
1145
|
-
</p>
|
|
1091
|
+
<div class='inline'>
|
|
1092
|
+
<p>a hash of params to be passed to the service</p>
|
|
1146
1093
|
</div>
|
|
1147
1094
|
|
|
1148
1095
|
</li>
|
|
@@ -1159,9 +1106,8 @@ a hash of params to be passed to the service
|
|
|
1159
1106
|
|
|
1160
1107
|
|
|
1161
1108
|
—
|
|
1162
|
-
<div class='inline'
|
|
1163
|
-
additional http headers
|
|
1164
|
-
</p>
|
|
1109
|
+
<div class='inline'>
|
|
1110
|
+
<p>additional http headers</p>
|
|
1165
1111
|
</div>
|
|
1166
1112
|
|
|
1167
1113
|
</li>
|
|
@@ -1181,9 +1127,8 @@ additional http headers
|
|
|
1181
1127
|
|
|
1182
1128
|
</span>
|
|
1183
1129
|
|
|
1184
|
-
— <div class='inline'
|
|
1185
|
-
Id of parameter
|
|
1186
|
-
</p>
|
|
1130
|
+
— <div class='inline'>
|
|
1131
|
+
<p>Id of parameter</p>
|
|
1187
1132
|
</div>
|
|
1188
1133
|
|
|
1189
1134
|
</li>
|
|
@@ -1195,9 +1140,8 @@ Id of parameter
|
|
|
1195
1140
|
|
|
1196
1141
|
</span>
|
|
1197
1142
|
|
|
1198
|
-
— <div class='inline'
|
|
1199
|
-
Id of domain
|
|
1200
|
-
</p>
|
|
1143
|
+
— <div class='inline'>
|
|
1144
|
+
<p>Id of domain</p>
|
|
1201
1145
|
</div>
|
|
1202
1146
|
|
|
1203
1147
|
</li>
|
|
@@ -1209,9 +1153,8 @@ Id of domain
|
|
|
1209
1153
|
|
|
1210
1154
|
</span>
|
|
1211
1155
|
|
|
1212
|
-
— <div class='inline'
|
|
1213
|
-
Id of host
|
|
1214
|
-
</p>
|
|
1156
|
+
— <div class='inline'>
|
|
1157
|
+
<p>Id of host</p>
|
|
1215
1158
|
</div>
|
|
1216
1159
|
|
|
1217
1160
|
</li>
|
|
@@ -1223,9 +1166,8 @@ Id of host
|
|
|
1223
1166
|
|
|
1224
1167
|
</span>
|
|
1225
1168
|
|
|
1226
|
-
— <div class='inline'
|
|
1227
|
-
Id of hostgroup
|
|
1228
|
-
</p>
|
|
1169
|
+
— <div class='inline'>
|
|
1170
|
+
<p>Id of hostgroup</p>
|
|
1229
1171
|
</div>
|
|
1230
1172
|
|
|
1231
1173
|
</li>
|
|
@@ -1237,9 +1179,8 @@ Id of hostgroup
|
|
|
1237
1179
|
|
|
1238
1180
|
</span>
|
|
1239
1181
|
|
|
1240
|
-
— <div class='inline'
|
|
1241
|
-
Id of operating system
|
|
1242
|
-
</p>
|
|
1182
|
+
— <div class='inline'>
|
|
1183
|
+
<p>Id of operating system</p>
|
|
1243
1184
|
</div>
|
|
1244
1185
|
|
|
1245
1186
|
</li>
|
|
@@ -1260,9 +1201,8 @@ Id of operating system
|
|
|
1260
1201
|
|
|
1261
1202
|
|
|
1262
1203
|
—
|
|
1263
|
-
<div class='inline'
|
|
1264
|
-
First item: parsed data; second item: raw body
|
|
1265
|
-
</p>
|
|
1204
|
+
<div class='inline'>
|
|
1205
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
1266
1206
|
</div>
|
|
1267
1207
|
|
|
1268
1208
|
</li>
|
|
@@ -1282,10 +1222,9 @@ First item: parsed data; second item: raw body
|
|
|
1282
1222
|
<td>
|
|
1283
1223
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 31</span>
|
|
1284
1224
|
|
|
1285
|
-
<span class='
|
|
1286
|
-
<span class='
|
|
1287
|
-
<span class='
|
|
1288
|
-
</pre>
|
|
1225
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1226
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
1227
|
+
<span class='kw'>end</span></pre>
|
|
1289
1228
|
</td>
|
|
1290
1229
|
</tr>
|
|
1291
1230
|
</table>
|
|
@@ -1302,9 +1241,8 @@ First item: parsed data; second item: raw body
|
|
|
1302
1241
|
|
|
1303
1242
|
</h3><div class="docstring">
|
|
1304
1243
|
<div class="discussion">
|
|
1305
|
-
|
|
1306
|
-
First item: parsed data; second item: raw body
|
|
1307
|
-
</p>
|
|
1244
|
+
|
|
1245
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
1308
1246
|
|
|
1309
1247
|
|
|
1310
1248
|
</div>
|
|
@@ -1325,9 +1263,8 @@ First item: parsed data; second item: raw body
|
|
|
1325
1263
|
|
|
1326
1264
|
|
|
1327
1265
|
—
|
|
1328
|
-
<div class='inline'
|
|
1329
|
-
a hash of params to be passed to the service
|
|
1330
|
-
</p>
|
|
1266
|
+
<div class='inline'>
|
|
1267
|
+
<p>a hash of params to be passed to the service</p>
|
|
1331
1268
|
</div>
|
|
1332
1269
|
|
|
1333
1270
|
</li>
|
|
@@ -1344,9 +1281,8 @@ a hash of params to be passed to the service
|
|
|
1344
1281
|
|
|
1345
1282
|
|
|
1346
1283
|
—
|
|
1347
|
-
<div class='inline'
|
|
1348
|
-
additional http headers
|
|
1349
|
-
</p>
|
|
1284
|
+
<div class='inline'>
|
|
1285
|
+
<p>additional http headers</p>
|
|
1350
1286
|
</div>
|
|
1351
1287
|
|
|
1352
1288
|
</li>
|
|
@@ -1366,9 +1302,8 @@ additional http headers
|
|
|
1366
1302
|
|
|
1367
1303
|
</span>
|
|
1368
1304
|
|
|
1369
|
-
— <div class='inline'
|
|
1370
|
-
Id of parameter
|
|
1371
|
-
</p>
|
|
1305
|
+
— <div class='inline'>
|
|
1306
|
+
<p>Id of parameter</p>
|
|
1372
1307
|
</div>
|
|
1373
1308
|
|
|
1374
1309
|
</li>
|
|
@@ -1380,9 +1315,8 @@ Id of parameter
|
|
|
1380
1315
|
|
|
1381
1316
|
</span>
|
|
1382
1317
|
|
|
1383
|
-
— <div class='inline'
|
|
1384
|
-
Id of domain
|
|
1385
|
-
</p>
|
|
1318
|
+
— <div class='inline'>
|
|
1319
|
+
<p>Id of domain</p>
|
|
1386
1320
|
</div>
|
|
1387
1321
|
|
|
1388
1322
|
</li>
|
|
@@ -1394,9 +1328,8 @@ Id of domain
|
|
|
1394
1328
|
|
|
1395
1329
|
</span>
|
|
1396
1330
|
|
|
1397
|
-
— <div class='inline'
|
|
1398
|
-
Id of host
|
|
1399
|
-
</p>
|
|
1331
|
+
— <div class='inline'>
|
|
1332
|
+
<p>Id of host</p>
|
|
1400
1333
|
</div>
|
|
1401
1334
|
|
|
1402
1335
|
</li>
|
|
@@ -1408,9 +1341,8 @@ Id of host
|
|
|
1408
1341
|
|
|
1409
1342
|
</span>
|
|
1410
1343
|
|
|
1411
|
-
— <div class='inline'
|
|
1412
|
-
Id of hostgroup
|
|
1413
|
-
</p>
|
|
1344
|
+
— <div class='inline'>
|
|
1345
|
+
<p>Id of hostgroup</p>
|
|
1414
1346
|
</div>
|
|
1415
1347
|
|
|
1416
1348
|
</li>
|
|
@@ -1422,9 +1354,8 @@ Id of hostgroup
|
|
|
1422
1354
|
|
|
1423
1355
|
</span>
|
|
1424
1356
|
|
|
1425
|
-
— <div class='inline'
|
|
1426
|
-
Id of operating system
|
|
1427
|
-
</p>
|
|
1357
|
+
— <div class='inline'>
|
|
1358
|
+
<p>Id of operating system</p>
|
|
1428
1359
|
</div>
|
|
1429
1360
|
|
|
1430
1361
|
</li>
|
|
@@ -1436,17 +1367,13 @@ Id of operating system
|
|
|
1436
1367
|
|
|
1437
1368
|
</span>
|
|
1438
1369
|
|
|
1439
|
-
— <div class='inline'
|
|
1440
|
-
allowed keys are
|
|
1441
|
-
|
|
1442
|
-
<
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
</li>
|
|
1446
|
-
<li>value [String]
|
|
1447
|
-
|
|
1448
|
-
</li>
|
|
1449
|
-
</ul>
|
|
1370
|
+
— <div class='inline'>
|
|
1371
|
+
<p>allowed keys are:</p>
|
|
1372
|
+
<ul><li>
|
|
1373
|
+
<p>name [String]</p>
|
|
1374
|
+
</li><li>
|
|
1375
|
+
<p>value [String]</p>
|
|
1376
|
+
</li></ul>
|
|
1450
1377
|
</div>
|
|
1451
1378
|
|
|
1452
1379
|
</li>
|
|
@@ -1467,9 +1394,8 @@ allowed keys are:
|
|
|
1467
1394
|
|
|
1468
1395
|
|
|
1469
1396
|
—
|
|
1470
|
-
<div class='inline'
|
|
1471
|
-
First item: parsed data; second item: raw body
|
|
1472
|
-
</p>
|
|
1397
|
+
<div class='inline'>
|
|
1398
|
+
<p>First item: parsed data; second item: raw body</p>
|
|
1473
1399
|
</div>
|
|
1474
1400
|
|
|
1475
1401
|
</li>
|
|
@@ -1489,10 +1415,9 @@ First item: parsed data; second item: raw body
|
|
|
1489
1415
|
<td>
|
|
1490
1416
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/parameter.rb', line 65</span>
|
|
1491
1417
|
|
|
1492
|
-
<span class='
|
|
1493
|
-
<span class='
|
|
1494
|
-
<span class='
|
|
1495
|
-
</pre>
|
|
1418
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1419
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
|
1420
|
+
<span class='kw'>end</span></pre>
|
|
1496
1421
|
</td>
|
|
1497
1422
|
</tr>
|
|
1498
1423
|
</table>
|
|
@@ -1503,9 +1428,9 @@ First item: parsed data; second item: raw body
|
|
|
1503
1428
|
</div>
|
|
1504
1429
|
|
|
1505
1430
|
<div id="footer">
|
|
1506
|
-
Generated on
|
|
1431
|
+
Generated on Thu Jun 20 12:05:22 2013 by
|
|
1507
1432
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1508
|
-
0.8.
|
|
1433
|
+
0.8.3 (ruby-1.9.3).
|
|
1509
1434
|
</div>
|
|
1510
1435
|
|
|
1511
1436
|
</body>
|