foreman_api 0.1.3 → 0.1.4
Sign up to get free protection for your applications and to get access to all the features.
- 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::Host
|
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,32 @@ 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
|
-
</
|
215
|
+
<span class="summary_desc"><div class='inline'>
|
216
|
+
<p>First item: parsed data; second item: raw body.</p>
|
217
|
+
</div></span>
|
218
|
+
|
219
|
+
</li>
|
220
|
+
|
221
|
+
|
222
|
+
<li class="public ">
|
223
|
+
<span class="summary_signature">
|
224
|
+
|
225
|
+
<a href="#puppetrun-instance_method" title="#puppetrun (instance method)">- (Array) <strong>puppetrun</strong>(params = {}, headers = {}) </a>
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
</span>
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
<span class="summary_desc"><div class='inline'>
|
240
|
+
<p>First item: parsed data; second item: raw body.</p>
|
220
241
|
</div></span>
|
221
242
|
|
222
243
|
</li>
|
@@ -239,9 +260,8 @@ First item: parsed data; second item: raw body.
|
|
239
260
|
|
240
261
|
|
241
262
|
|
242
|
-
<span class="summary_desc"><div class='inline'
|
243
|
-
First item: parsed data; second item: raw body
|
244
|
-
</p>
|
263
|
+
<span class="summary_desc"><div class='inline'>
|
264
|
+
<p>First item: parsed data; second item: raw body.</p>
|
245
265
|
</div></span>
|
246
266
|
|
247
267
|
</li>
|
@@ -264,9 +284,8 @@ First item: parsed data; second item: raw body.
|
|
264
284
|
|
265
285
|
|
266
286
|
|
267
|
-
<span class="summary_desc"><div class='inline'
|
268
|
-
First item: parsed data; second item: raw body
|
269
|
-
</p>
|
287
|
+
<span class="summary_desc"><div class='inline'>
|
288
|
+
<p>First item: parsed data; second item: raw body.</p>
|
270
289
|
</div></span>
|
271
290
|
|
272
291
|
</li>
|
@@ -289,9 +308,8 @@ First item: parsed data; second item: raw body.
|
|
289
308
|
|
290
309
|
|
291
310
|
|
292
|
-
<span class="summary_desc"><div class='inline'
|
293
|
-
First item: parsed data; second item: raw body
|
294
|
-
</p>
|
311
|
+
<span class="summary_desc"><div class='inline'>
|
312
|
+
<p>First item: parsed data; second item: raw body.</p>
|
295
313
|
</div></span>
|
296
314
|
|
297
315
|
</li>
|
@@ -329,10 +347,9 @@ First item: parsed data; second item: raw body.
|
|
329
347
|
<td>
|
330
348
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 4</span>
|
331
349
|
|
332
|
-
<span class='
|
333
|
-
<span class='
|
334
|
-
<span class='
|
335
|
-
</pre>
|
350
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
|
351
|
+
<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'>hosts</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
352
|
+
<span class='kw'>end</span></pre>
|
336
353
|
</td>
|
337
354
|
</tr>
|
338
355
|
</table>
|
@@ -355,9 +372,8 @@ First item: parsed data; second item: raw body.
|
|
355
372
|
|
356
373
|
</h3><div class="docstring">
|
357
374
|
<div class="discussion">
|
358
|
-
|
359
|
-
First item: parsed data; second item: raw body
|
360
|
-
</p>
|
375
|
+
|
376
|
+
<p>First item: parsed data; second item: raw body</p>
|
361
377
|
|
362
378
|
|
363
379
|
</div>
|
@@ -378,9 +394,8 @@ First item: parsed data; second item: raw body
|
|
378
394
|
|
379
395
|
|
380
396
|
—
|
381
|
-
<div class='inline'
|
382
|
-
a hash of params to be passed to the service
|
383
|
-
</p>
|
397
|
+
<div class='inline'>
|
398
|
+
<p>a hash of params to be passed to the service</p>
|
384
399
|
</div>
|
385
400
|
|
386
401
|
</li>
|
@@ -397,9 +412,8 @@ a hash of params to be passed to the service
|
|
397
412
|
|
398
413
|
|
399
414
|
—
|
400
|
-
<div class='inline'
|
401
|
-
additional http headers
|
402
|
-
</p>
|
415
|
+
<div class='inline'>
|
416
|
+
<p>additional http headers</p>
|
403
417
|
</div>
|
404
418
|
|
405
419
|
</li>
|
@@ -419,65 +433,45 @@ additional http headers
|
|
419
433
|
|
420
434
|
</span>
|
421
435
|
|
422
|
-
— <div class='inline'
|
423
|
-
allowed keys are
|
424
|
-
|
425
|
-
<
|
426
|
-
|
427
|
-
|
428
|
-
</li>
|
429
|
-
<
|
430
|
-
|
431
|
-
</
|
432
|
-
|
433
|
-
|
434
|
-
</li>
|
435
|
-
<
|
436
|
-
|
437
|
-
</
|
438
|
-
|
439
|
-
|
440
|
-
</li>
|
441
|
-
<
|
442
|
-
|
443
|
-
</
|
444
|
-
|
445
|
-
|
446
|
-
</li>
|
447
|
-
<
|
448
|
-
|
449
|
-
</
|
450
|
-
|
451
|
-
|
452
|
-
</li>
|
453
|
-
<
|
454
|
-
|
455
|
-
</
|
456
|
-
|
457
|
-
|
458
|
-
</li>
|
459
|
-
<
|
460
|
-
|
461
|
-
</li>
|
462
|
-
<li>sp_subnet_id [String]
|
463
|
-
|
464
|
-
</li>
|
465
|
-
<li>subnet_id [String]
|
466
|
-
|
467
|
-
</li>
|
468
|
-
<li>host_parameters_attributes [String]
|
469
|
-
|
470
|
-
</li>
|
471
|
-
<li>ip [String] Not required if using a subnet with dhcp proxy
|
472
|
-
|
473
|
-
</li>
|
474
|
-
<li>mac [String] Not required if its a virtual machine
|
475
|
-
|
476
|
-
</li>
|
477
|
-
<li>name [String]
|
478
|
-
|
479
|
-
</li>
|
480
|
-
</ul>
|
436
|
+
— <div class='inline'>
|
437
|
+
<p>allowed keys are:</p>
|
438
|
+
<ul><li>
|
439
|
+
<p>architecture_id [String]</p>
|
440
|
+
</li><li>
|
441
|
+
<p>domain_id [String]</p>
|
442
|
+
</li><li>
|
443
|
+
<p>environment_id [String]</p>
|
444
|
+
</li><li>
|
445
|
+
<p>hostgroup_id [String]</p>
|
446
|
+
</li><li>
|
447
|
+
<p>image_id [String]</p>
|
448
|
+
</li><li>
|
449
|
+
<p>medium_id [String]</p>
|
450
|
+
</li><li>
|
451
|
+
<p>model_id_id [String]</p>
|
452
|
+
</li><li>
|
453
|
+
<p>operatingsystem_id [String]</p>
|
454
|
+
</li><li>
|
455
|
+
<p>owner_id [String]</p>
|
456
|
+
</li><li>
|
457
|
+
<p>ptable_id [String]</p>
|
458
|
+
</li><li>
|
459
|
+
<p>puppet_ca_proxy_id [String]</p>
|
460
|
+
</li><li>
|
461
|
+
<p>puppet_proxy_id [String]</p>
|
462
|
+
</li><li>
|
463
|
+
<p>sp_subnet_id [String]</p>
|
464
|
+
</li><li>
|
465
|
+
<p>subnet_id [String]</p>
|
466
|
+
</li><li>
|
467
|
+
<p>host_parameters_attributes [String]</p>
|
468
|
+
</li><li>
|
469
|
+
<p>ip [String] Not required if using a subnet with dhcp proxy</p>
|
470
|
+
</li><li>
|
471
|
+
<p>mac [String] Not required if its a virtual machine</p>
|
472
|
+
</li><li>
|
473
|
+
<p>name [String]</p>
|
474
|
+
</li></ul>
|
481
475
|
</div>
|
482
476
|
|
483
477
|
</li>
|
@@ -498,9 +492,8 @@ allowed keys are:
|
|
498
492
|
|
499
493
|
|
500
494
|
—
|
501
|
-
<div class='inline'
|
502
|
-
First item: parsed data; second item: raw body
|
503
|
-
</p>
|
495
|
+
<div class='inline'>
|
496
|
+
<p>First item: parsed data; second item: raw body</p>
|
504
497
|
</div>
|
505
498
|
|
506
499
|
</li>
|
@@ -520,10 +513,9 @@ First item: parsed data; second item: raw body
|
|
520
513
|
<td>
|
521
514
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 53</span>
|
522
515
|
|
523
|
-
<span class='
|
524
|
-
<span class='
|
525
|
-
<span class='
|
526
|
-
</pre>
|
516
|
+
<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>
|
517
|
+
<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>
|
518
|
+
<span class='kw'>end</span></pre>
|
527
519
|
</td>
|
528
520
|
</tr>
|
529
521
|
</table>
|
@@ -540,9 +532,8 @@ First item: parsed data; second item: raw body
|
|
540
532
|
|
541
533
|
</h3><div class="docstring">
|
542
534
|
<div class="discussion">
|
543
|
-
|
544
|
-
First item: parsed data; second item: raw body
|
545
|
-
</p>
|
535
|
+
|
536
|
+
<p>First item: parsed data; second item: raw body</p>
|
546
537
|
|
547
538
|
|
548
539
|
</div>
|
@@ -563,9 +554,8 @@ First item: parsed data; second item: raw body
|
|
563
554
|
|
564
555
|
|
565
556
|
—
|
566
|
-
<div class='inline'
|
567
|
-
a hash of params to be passed to the service
|
568
|
-
</p>
|
557
|
+
<div class='inline'>
|
558
|
+
<p>a hash of params to be passed to the service</p>
|
569
559
|
</div>
|
570
560
|
|
571
561
|
</li>
|
@@ -582,9 +572,8 @@ a hash of params to be passed to the service
|
|
582
572
|
|
583
573
|
|
584
574
|
—
|
585
|
-
<div class='inline'
|
586
|
-
additional http headers
|
587
|
-
</p>
|
575
|
+
<div class='inline'>
|
576
|
+
<p>additional http headers</p>
|
588
577
|
</div>
|
589
578
|
|
590
579
|
</li>
|
@@ -622,9 +611,8 @@ additional http headers
|
|
622
611
|
|
623
612
|
|
624
613
|
—
|
625
|
-
<div class='inline'
|
626
|
-
First item: parsed data; second item: raw body
|
627
|
-
</p>
|
614
|
+
<div class='inline'>
|
615
|
+
<p>First item: parsed data; second item: raw body</p>
|
628
616
|
</div>
|
629
617
|
|
630
618
|
</li>
|
@@ -644,10 +632,9 @@ First item: parsed data; second item: raw body
|
|
644
632
|
<td>
|
645
633
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 91</span>
|
646
634
|
|
647
|
-
<span class='
|
648
|
-
<span class='
|
649
|
-
<span class='
|
650
|
-
</pre>
|
635
|
+
<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>
|
636
|
+
<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>
|
637
|
+
<span class='kw'>end</span></pre>
|
651
638
|
</td>
|
652
639
|
</tr>
|
653
640
|
</table>
|
@@ -664,9 +651,8 @@ First item: parsed data; second item: raw body
|
|
664
651
|
|
665
652
|
</h3><div class="docstring">
|
666
653
|
<div class="discussion">
|
667
|
-
|
668
|
-
First item: parsed data; second item: raw body
|
669
|
-
</p>
|
654
|
+
|
655
|
+
<p>First item: parsed data; second item: raw body</p>
|
670
656
|
|
671
657
|
|
672
658
|
</div>
|
@@ -687,9 +673,8 @@ First item: parsed data; second item: raw body
|
|
687
673
|
|
688
674
|
|
689
675
|
—
|
690
|
-
<div class='inline'
|
691
|
-
a hash of params to be passed to the service
|
692
|
-
</p>
|
676
|
+
<div class='inline'>
|
677
|
+
<p>a hash of params to be passed to the service</p>
|
693
678
|
</div>
|
694
679
|
|
695
680
|
</li>
|
@@ -706,9 +691,8 @@ a hash of params to be passed to the service
|
|
706
691
|
|
707
692
|
|
708
693
|
—
|
709
|
-
<div class='inline'
|
710
|
-
additional http headers
|
711
|
-
</p>
|
694
|
+
<div class='inline'>
|
695
|
+
<p>additional http headers</p>
|
712
696
|
</div>
|
713
697
|
|
714
698
|
</li>
|
@@ -728,9 +712,8 @@ additional http headers
|
|
728
712
|
|
729
713
|
</span>
|
730
714
|
|
731
|
-
— <div class='inline'
|
732
|
-
Sort results
|
733
|
-
</p>
|
715
|
+
— <div class='inline'>
|
716
|
+
<p>Sort results</p>
|
734
717
|
</div>
|
735
718
|
|
736
719
|
</li>
|
@@ -742,9 +725,8 @@ Sort results
|
|
742
725
|
|
743
726
|
</span>
|
744
727
|
|
745
|
-
— <div class='inline'
|
746
|
-
Paginate results
|
747
|
-
</p>
|
728
|
+
— <div class='inline'>
|
729
|
+
<p>Paginate results</p>
|
748
730
|
</div>
|
749
731
|
|
750
732
|
</li>
|
@@ -756,9 +738,8 @@ Paginate results
|
|
756
738
|
|
757
739
|
</span>
|
758
740
|
|
759
|
-
— <div class='inline'
|
760
|
-
Number of entries per request
|
761
|
-
</p>
|
741
|
+
— <div class='inline'>
|
742
|
+
<p>Number of entries per request</p>
|
762
743
|
</div>
|
763
744
|
|
764
745
|
</li>
|
@@ -770,9 +751,8 @@ Number of entries per request
|
|
770
751
|
|
771
752
|
</span>
|
772
753
|
|
773
|
-
— <div class='inline'
|
774
|
-
Filter results
|
775
|
-
</p>
|
754
|
+
— <div class='inline'>
|
755
|
+
<p>Filter results</p>
|
776
756
|
</div>
|
777
757
|
|
778
758
|
</li>
|
@@ -793,9 +773,8 @@ Filter results
|
|
793
773
|
|
794
774
|
|
795
775
|
—
|
796
|
-
<div class='inline'
|
797
|
-
First item: parsed data; second item: raw body
|
798
|
-
</p>
|
776
|
+
<div class='inline'>
|
777
|
+
<p>First item: parsed data; second item: raw body</p>
|
799
778
|
</div>
|
800
779
|
|
801
780
|
</li>
|
@@ -815,10 +794,132 @@ First item: parsed data; second item: raw body
|
|
815
794
|
<td>
|
816
795
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 16</span>
|
817
796
|
|
818
|
-
<span class='
|
819
|
-
<span class='
|
820
|
-
<span class='
|
821
|
-
</
|
797
|
+
<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>
|
798
|
+
<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>
|
799
|
+
<span class='kw'>end</span></pre>
|
800
|
+
</td>
|
801
|
+
</tr>
|
802
|
+
</table>
|
803
|
+
</div>
|
804
|
+
|
805
|
+
<div class="method_details ">
|
806
|
+
<h3 class="signature " id="puppetrun-instance_method">
|
807
|
+
|
808
|
+
- (<tt>Array</tt>) <strong>puppetrun</strong>(params = {}, headers = {})
|
809
|
+
|
810
|
+
|
811
|
+
|
812
|
+
|
813
|
+
|
814
|
+
</h3><div class="docstring">
|
815
|
+
<div class="discussion">
|
816
|
+
|
817
|
+
<p>First item: parsed data; second item: raw body</p>
|
818
|
+
|
819
|
+
|
820
|
+
</div>
|
821
|
+
</div>
|
822
|
+
<div class="tags">
|
823
|
+
<p class="tag_title">Parameters:</p>
|
824
|
+
<ul class="param">
|
825
|
+
|
826
|
+
<li>
|
827
|
+
|
828
|
+
<span class='name'>params</span>
|
829
|
+
|
830
|
+
|
831
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
832
|
+
|
833
|
+
|
834
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
835
|
+
|
836
|
+
|
837
|
+
—
|
838
|
+
<div class='inline'>
|
839
|
+
<p>a hash of params to be passed to the service</p>
|
840
|
+
</div>
|
841
|
+
|
842
|
+
</li>
|
843
|
+
|
844
|
+
<li>
|
845
|
+
|
846
|
+
<span class='name'>headers</span>
|
847
|
+
|
848
|
+
|
849
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
850
|
+
|
851
|
+
|
852
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
853
|
+
|
854
|
+
|
855
|
+
—
|
856
|
+
<div class='inline'>
|
857
|
+
<p>additional http headers</p>
|
858
|
+
</div>
|
859
|
+
|
860
|
+
</li>
|
861
|
+
|
862
|
+
</ul>
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
868
|
+
<ul class="option">
|
869
|
+
|
870
|
+
<li>
|
871
|
+
<span class="name">id</span>
|
872
|
+
<span class="type">(<tt>Object</tt>)</span>
|
873
|
+
<span class="default">
|
874
|
+
|
875
|
+
</span>
|
876
|
+
|
877
|
+
— <div class='inline'>
|
878
|
+
<p>Part of <tt>/api/hosts/:id/puppetrun</tt> path</p>
|
879
|
+
</div>
|
880
|
+
|
881
|
+
</li>
|
882
|
+
|
883
|
+
</ul>
|
884
|
+
|
885
|
+
|
886
|
+
|
887
|
+
|
888
|
+
<p class="tag_title">Returns:</p>
|
889
|
+
<ul class="return">
|
890
|
+
|
891
|
+
<li>
|
892
|
+
|
893
|
+
|
894
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
895
|
+
|
896
|
+
|
897
|
+
|
898
|
+
—
|
899
|
+
<div class='inline'>
|
900
|
+
<p>First item: parsed data; second item: raw body</p>
|
901
|
+
</div>
|
902
|
+
|
903
|
+
</li>
|
904
|
+
|
905
|
+
</ul>
|
906
|
+
|
907
|
+
</div><table class="source_code">
|
908
|
+
<tr>
|
909
|
+
<td>
|
910
|
+
<pre class="lines">
|
911
|
+
|
912
|
+
|
913
|
+
109
|
914
|
+
110
|
915
|
+
111</pre>
|
916
|
+
</td>
|
917
|
+
<td>
|
918
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 109</span>
|
919
|
+
|
920
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_puppetrun'>puppetrun</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>
|
921
|
+
<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>
|
922
|
+
<span class='kw'>end</span></pre>
|
822
923
|
</td>
|
823
924
|
</tr>
|
824
925
|
</table>
|
@@ -835,9 +936,8 @@ First item: parsed data; second item: raw body
|
|
835
936
|
|
836
937
|
</h3><div class="docstring">
|
837
938
|
<div class="discussion">
|
838
|
-
|
839
|
-
First item: parsed data; second item: raw body
|
840
|
-
</p>
|
939
|
+
|
940
|
+
<p>First item: parsed data; second item: raw body</p>
|
841
941
|
|
842
942
|
|
843
943
|
</div>
|
@@ -858,9 +958,8 @@ First item: parsed data; second item: raw body
|
|
858
958
|
|
859
959
|
|
860
960
|
—
|
861
|
-
<div class='inline'
|
862
|
-
a hash of params to be passed to the service
|
863
|
-
</p>
|
961
|
+
<div class='inline'>
|
962
|
+
<p>a hash of params to be passed to the service</p>
|
864
963
|
</div>
|
865
964
|
|
866
965
|
</li>
|
@@ -877,9 +976,8 @@ a hash of params to be passed to the service
|
|
877
976
|
|
878
977
|
|
879
978
|
—
|
880
|
-
<div class='inline'
|
881
|
-
additional http headers
|
882
|
-
</p>
|
979
|
+
<div class='inline'>
|
980
|
+
<p>additional http headers</p>
|
883
981
|
</div>
|
884
982
|
|
885
983
|
</li>
|
@@ -917,9 +1015,8 @@ additional http headers
|
|
917
1015
|
|
918
1016
|
|
919
1017
|
—
|
920
|
-
<div class='inline'
|
921
|
-
First item: parsed data; second item: raw body
|
922
|
-
</p>
|
1018
|
+
<div class='inline'>
|
1019
|
+
<p>First item: parsed data; second item: raw body</p>
|
923
1020
|
</div>
|
924
1021
|
|
925
1022
|
</li>
|
@@ -939,10 +1036,9 @@ First item: parsed data; second item: raw body
|
|
939
1036
|
<td>
|
940
1037
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 25</span>
|
941
1038
|
|
942
|
-
<span class='
|
943
|
-
<span class='
|
944
|
-
<span class='
|
945
|
-
</pre>
|
1039
|
+
<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>
|
1040
|
+
<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>
|
1041
|
+
<span class='kw'>end</span></pre>
|
946
1042
|
</td>
|
947
1043
|
</tr>
|
948
1044
|
</table>
|
@@ -959,9 +1055,8 @@ First item: parsed data; second item: raw body
|
|
959
1055
|
|
960
1056
|
</h3><div class="docstring">
|
961
1057
|
<div class="discussion">
|
962
|
-
|
963
|
-
First item: parsed data; second item: raw body
|
964
|
-
</p>
|
1058
|
+
|
1059
|
+
<p>First item: parsed data; second item: raw body</p>
|
965
1060
|
|
966
1061
|
|
967
1062
|
</div>
|
@@ -982,9 +1077,8 @@ First item: parsed data; second item: raw body
|
|
982
1077
|
|
983
1078
|
|
984
1079
|
—
|
985
|
-
<div class='inline'
|
986
|
-
a hash of params to be passed to the service
|
987
|
-
</p>
|
1080
|
+
<div class='inline'>
|
1081
|
+
<p>a hash of params to be passed to the service</p>
|
988
1082
|
</div>
|
989
1083
|
|
990
1084
|
</li>
|
@@ -1001,9 +1095,8 @@ a hash of params to be passed to the service
|
|
1001
1095
|
|
1002
1096
|
|
1003
1097
|
—
|
1004
|
-
<div class='inline'
|
1005
|
-
additional http headers
|
1006
|
-
</p>
|
1098
|
+
<div class='inline'>
|
1099
|
+
<p>additional http headers</p>
|
1007
1100
|
</div>
|
1008
1101
|
|
1009
1102
|
</li>
|
@@ -1041,9 +1134,8 @@ additional http headers
|
|
1041
1134
|
|
1042
1135
|
|
1043
1136
|
—
|
1044
|
-
<div class='inline'
|
1045
|
-
First item: parsed data; second item: raw body
|
1046
|
-
</p>
|
1137
|
+
<div class='inline'>
|
1138
|
+
<p>First item: parsed data; second item: raw body</p>
|
1047
1139
|
</div>
|
1048
1140
|
|
1049
1141
|
</li>
|
@@ -1063,10 +1155,9 @@ First item: parsed data; second item: raw body
|
|
1063
1155
|
<td>
|
1064
1156
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 100</span>
|
1065
1157
|
|
1066
|
-
<span class='
|
1067
|
-
<span class='
|
1068
|
-
<span class='
|
1069
|
-
</pre>
|
1158
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</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>
|
1159
|
+
<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>
|
1160
|
+
<span class='kw'>end</span></pre>
|
1070
1161
|
</td>
|
1071
1162
|
</tr>
|
1072
1163
|
</table>
|
@@ -1083,9 +1174,8 @@ First item: parsed data; second item: raw body
|
|
1083
1174
|
|
1084
1175
|
</h3><div class="docstring">
|
1085
1176
|
<div class="discussion">
|
1086
|
-
|
1087
|
-
First item: parsed data; second item: raw body
|
1088
|
-
</p>
|
1177
|
+
|
1178
|
+
<p>First item: parsed data; second item: raw body</p>
|
1089
1179
|
|
1090
1180
|
|
1091
1181
|
</div>
|
@@ -1106,9 +1196,8 @@ First item: parsed data; second item: raw body
|
|
1106
1196
|
|
1107
1197
|
|
1108
1198
|
—
|
1109
|
-
<div class='inline'
|
1110
|
-
a hash of params to be passed to the service
|
1111
|
-
</p>
|
1199
|
+
<div class='inline'>
|
1200
|
+
<p>a hash of params to be passed to the service</p>
|
1112
1201
|
</div>
|
1113
1202
|
|
1114
1203
|
</li>
|
@@ -1125,9 +1214,8 @@ a hash of params to be passed to the service
|
|
1125
1214
|
|
1126
1215
|
|
1127
1216
|
—
|
1128
|
-
<div class='inline'
|
1129
|
-
additional http headers
|
1130
|
-
</p>
|
1217
|
+
<div class='inline'>
|
1218
|
+
<p>additional http headers</p>
|
1131
1219
|
</div>
|
1132
1220
|
|
1133
1221
|
</li>
|
@@ -1156,65 +1244,45 @@ additional http headers
|
|
1156
1244
|
|
1157
1245
|
</span>
|
1158
1246
|
|
1159
|
-
— <div class='inline'
|
1160
|
-
allowed keys are
|
1161
|
-
|
1162
|
-
<
|
1163
|
-
|
1164
|
-
|
1165
|
-
</li>
|
1166
|
-
<
|
1167
|
-
|
1168
|
-
</
|
1169
|
-
|
1170
|
-
|
1171
|
-
</li>
|
1172
|
-
<
|
1173
|
-
|
1174
|
-
</
|
1175
|
-
|
1176
|
-
|
1177
|
-
</li>
|
1178
|
-
<
|
1179
|
-
|
1180
|
-
</
|
1181
|
-
|
1182
|
-
|
1183
|
-
</li>
|
1184
|
-
<
|
1185
|
-
|
1186
|
-
</
|
1187
|
-
|
1188
|
-
|
1189
|
-
</li>
|
1190
|
-
<
|
1191
|
-
|
1192
|
-
</
|
1193
|
-
|
1194
|
-
|
1195
|
-
</li>
|
1196
|
-
<
|
1197
|
-
|
1198
|
-
</li>
|
1199
|
-
<li>sp_subnet_id [String]
|
1200
|
-
|
1201
|
-
</li>
|
1202
|
-
<li>subnet_id [String]
|
1203
|
-
|
1204
|
-
</li>
|
1205
|
-
<li>host_parameters_attributes [String]
|
1206
|
-
|
1207
|
-
</li>
|
1208
|
-
<li>ip [String] Not required if using a subnet with dhcp proxy
|
1209
|
-
|
1210
|
-
</li>
|
1211
|
-
<li>mac [String] Not required if its a virtual machine
|
1212
|
-
|
1213
|
-
</li>
|
1214
|
-
<li>name [String]
|
1215
|
-
|
1216
|
-
</li>
|
1217
|
-
</ul>
|
1247
|
+
— <div class='inline'>
|
1248
|
+
<p>allowed keys are:</p>
|
1249
|
+
<ul><li>
|
1250
|
+
<p>architecture_id [String]</p>
|
1251
|
+
</li><li>
|
1252
|
+
<p>domain_id [String]</p>
|
1253
|
+
</li><li>
|
1254
|
+
<p>environment_id [String]</p>
|
1255
|
+
</li><li>
|
1256
|
+
<p>hostgroup_id [String]</p>
|
1257
|
+
</li><li>
|
1258
|
+
<p>image_id [String]</p>
|
1259
|
+
</li><li>
|
1260
|
+
<p>medium_id [String]</p>
|
1261
|
+
</li><li>
|
1262
|
+
<p>model_id_id [String]</p>
|
1263
|
+
</li><li>
|
1264
|
+
<p>operatingsystem_id [String]</p>
|
1265
|
+
</li><li>
|
1266
|
+
<p>owner_id [String]</p>
|
1267
|
+
</li><li>
|
1268
|
+
<p>ptable_id [String]</p>
|
1269
|
+
</li><li>
|
1270
|
+
<p>puppet_ca_proxy_id [String]</p>
|
1271
|
+
</li><li>
|
1272
|
+
<p>puppet_proxy_id [String]</p>
|
1273
|
+
</li><li>
|
1274
|
+
<p>sp_subnet_id [String]</p>
|
1275
|
+
</li><li>
|
1276
|
+
<p>subnet_id [String]</p>
|
1277
|
+
</li><li>
|
1278
|
+
<p>host_parameters_attributes [String]</p>
|
1279
|
+
</li><li>
|
1280
|
+
<p>ip [String] Not required if using a subnet with dhcp proxy</p>
|
1281
|
+
</li><li>
|
1282
|
+
<p>mac [String] Not required if its a virtual machine</p>
|
1283
|
+
</li><li>
|
1284
|
+
<p>name [String]</p>
|
1285
|
+
</li></ul>
|
1218
1286
|
</div>
|
1219
1287
|
|
1220
1288
|
</li>
|
@@ -1235,9 +1303,8 @@ allowed keys are:
|
|
1235
1303
|
|
1236
1304
|
|
1237
1305
|
—
|
1238
|
-
<div class='inline'
|
1239
|
-
First item: parsed data; second item: raw body
|
1240
|
-
</p>
|
1306
|
+
<div class='inline'>
|
1307
|
+
<p>First item: parsed data; second item: raw body</p>
|
1241
1308
|
</div>
|
1242
1309
|
|
1243
1310
|
</li>
|
@@ -1257,10 +1324,9 @@ First item: parsed data; second item: raw body
|
|
1257
1324
|
<td>
|
1258
1325
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 82</span>
|
1259
1326
|
|
1260
|
-
<span class='
|
1261
|
-
<span class='
|
1262
|
-
<span class='
|
1263
|
-
</pre>
|
1327
|
+
<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>
|
1328
|
+
<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>
|
1329
|
+
<span class='kw'>end</span></pre>
|
1264
1330
|
</td>
|
1265
1331
|
</tr>
|
1266
1332
|
</table>
|
@@ -1271,9 +1337,9 @@ First item: parsed data; second item: raw body
|
|
1271
1337
|
</div>
|
1272
1338
|
|
1273
1339
|
<div id="footer">
|
1274
|
-
Generated on
|
1340
|
+
Generated on Thu Jun 20 12:05:20 2013 by
|
1275
1341
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1276
|
-
0.8.
|
1342
|
+
0.8.3 (ruby-1.9.3).
|
1277
1343
|
</div>
|
1278
1344
|
|
1279
1345
|
</body>
|