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::Hostgroup
|
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/hostgroup.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'>"hostgroups"</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,29 +394,41 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
</li
|
383
|
-
<
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
</li
|
389
|
-
<
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
</li
|
395
|
-
<
|
396
|
-
|
397
|
-
|
398
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>architecture_id [String]
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>domain_id [String]
|
405
|
+
|
406
|
+
</li>
|
407
|
+
<li>environment_id [String]
|
408
|
+
|
409
|
+
</li>
|
410
|
+
<li>medium_id [String]
|
411
|
+
|
412
|
+
</li>
|
413
|
+
<li>operatingsystem_id [String]
|
414
|
+
|
415
|
+
</li>
|
416
|
+
<li>ptable_id [String]
|
417
|
+
|
418
|
+
</li>
|
419
|
+
<li>puppet_ca_proxy_id [String]
|
420
|
+
|
421
|
+
</li>
|
422
|
+
<li>puppet_proxy_id [String]
|
423
|
+
|
424
|
+
</li>
|
425
|
+
<li>subnet_id [String]
|
426
|
+
|
427
|
+
</li>
|
428
|
+
<li>name [String]
|
429
|
+
|
430
|
+
</li>
|
431
|
+
</ul>
|
399
432
|
</div>
|
400
433
|
|
401
434
|
</li>
|
@@ -405,6 +438,25 @@
|
|
405
438
|
|
406
439
|
|
407
440
|
|
441
|
+
<p class="tag_title">Returns:</p>
|
442
|
+
<ul class="return">
|
443
|
+
|
444
|
+
<li>
|
445
|
+
|
446
|
+
|
447
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
—
|
452
|
+
<div class='inline'><p>
|
453
|
+
First item: parsed data; second item: raw body
|
454
|
+
</p>
|
455
|
+
</div>
|
456
|
+
|
457
|
+
</li>
|
458
|
+
|
459
|
+
</ul>
|
408
460
|
|
409
461
|
</div><table class="source_code">
|
410
462
|
<tr>
|
@@ -412,20 +464,17 @@
|
|
412
464
|
<pre class="lines">
|
413
465
|
|
414
466
|
|
467
|
+
45
|
415
468
|
46
|
416
|
-
47
|
417
|
-
48
|
418
|
-
49
|
419
|
-
50</pre>
|
469
|
+
47</pre>
|
420
470
|
</td>
|
421
471
|
<td>
|
422
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line
|
472
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line 45</span>
|
423
473
|
|
424
|
-
<span class='kw'>def</span> <span class='
|
425
|
-
<span class='
|
426
|
-
|
427
|
-
|
428
|
-
<span class='kw'>end</span></pre>
|
474
|
+
<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>
|
475
|
+
<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>
|
476
|
+
<span class='rubyid_end end kw'>end</span>
|
477
|
+
</pre>
|
429
478
|
</td>
|
430
479
|
</tr>
|
431
480
|
</table>
|
@@ -434,7 +483,7 @@
|
|
434
483
|
<div class="method_details ">
|
435
484
|
<h3 class="signature " id="destroy-instance_method">
|
436
485
|
|
437
|
-
- (<tt>
|
486
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
438
487
|
|
439
488
|
|
440
489
|
|
@@ -442,7 +491,10 @@
|
|
442
491
|
|
443
492
|
</h3><div class="docstring">
|
444
493
|
<div class="discussion">
|
445
|
-
|
494
|
+
<p>
|
495
|
+
First item: parsed data; second item: raw body
|
496
|
+
</p>
|
497
|
+
|
446
498
|
|
447
499
|
</div>
|
448
500
|
</div>
|
@@ -458,12 +510,13 @@
|
|
458
510
|
<span class='type'>(<tt>Hash</tt>)</span>
|
459
511
|
|
460
512
|
|
461
|
-
<em class="default">(defaults to: <tt>{
|
513
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
462
514
|
|
463
515
|
|
464
516
|
—
|
465
|
-
<div class='inline'>
|
466
|
-
|
517
|
+
<div class='inline'><p>
|
518
|
+
a hash of params to be passed to the service
|
519
|
+
</p>
|
467
520
|
</div>
|
468
521
|
|
469
522
|
</li>
|
@@ -476,12 +529,13 @@
|
|
476
529
|
<span class='type'>(<tt>Hash</tt>)</span>
|
477
530
|
|
478
531
|
|
479
|
-
<em class="default">(defaults to: <tt>{
|
532
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
480
533
|
|
481
534
|
|
482
535
|
—
|
483
|
-
<div class='inline'>
|
484
|
-
|
536
|
+
<div class='inline'><p>
|
537
|
+
additional http headers
|
538
|
+
</p>
|
485
539
|
</div>
|
486
540
|
|
487
541
|
</li>
|
@@ -508,6 +562,25 @@
|
|
508
562
|
|
509
563
|
|
510
564
|
|
565
|
+
<p class="tag_title">Returns:</p>
|
566
|
+
<ul class="return">
|
567
|
+
|
568
|
+
<li>
|
569
|
+
|
570
|
+
|
571
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
—
|
576
|
+
<div class='inline'><p>
|
577
|
+
First item: parsed data; second item: raw body
|
578
|
+
</p>
|
579
|
+
</div>
|
580
|
+
|
581
|
+
</li>
|
582
|
+
|
583
|
+
</ul>
|
511
584
|
|
512
585
|
</div><table class="source_code">
|
513
586
|
<tr>
|
@@ -515,20 +588,17 @@
|
|
515
588
|
<pre class="lines">
|
516
589
|
|
517
590
|
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
81
|
522
|
-
82</pre>
|
591
|
+
75
|
592
|
+
76
|
593
|
+
77</pre>
|
523
594
|
</td>
|
524
595
|
<td>
|
525
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line
|
596
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line 75</span>
|
526
597
|
|
527
|
-
<span class='kw'>def</span> <span class='
|
528
|
-
<span class='
|
529
|
-
|
530
|
-
|
531
|
-
<span class='kw'>end</span></pre>
|
598
|
+
<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>
|
599
|
+
<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>
|
600
|
+
<span class='rubyid_end end kw'>end</span>
|
601
|
+
</pre>
|
532
602
|
</td>
|
533
603
|
</tr>
|
534
604
|
</table>
|
@@ -537,7 +607,7 @@
|
|
537
607
|
<div class="method_details ">
|
538
608
|
<h3 class="signature " id="index-instance_method">
|
539
609
|
|
540
|
-
- (<tt>
|
610
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
541
611
|
|
542
612
|
|
543
613
|
|
@@ -545,7 +615,10 @@
|
|
545
615
|
|
546
616
|
</h3><div class="docstring">
|
547
617
|
<div class="discussion">
|
548
|
-
|
618
|
+
<p>
|
619
|
+
First item: parsed data; second item: raw body
|
620
|
+
</p>
|
621
|
+
|
549
622
|
|
550
623
|
</div>
|
551
624
|
</div>
|
@@ -561,12 +634,13 @@
|
|
561
634
|
<span class='type'>(<tt>Hash</tt>)</span>
|
562
635
|
|
563
636
|
|
564
|
-
<em class="default">(defaults to: <tt>{
|
637
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
565
638
|
|
566
639
|
|
567
640
|
—
|
568
|
-
<div class='inline'>
|
569
|
-
|
641
|
+
<div class='inline'><p>
|
642
|
+
a hash of params to be passed to the service
|
643
|
+
</p>
|
570
644
|
</div>
|
571
645
|
|
572
646
|
</li>
|
@@ -579,12 +653,13 @@
|
|
579
653
|
<span class='type'>(<tt>Hash</tt>)</span>
|
580
654
|
|
581
655
|
|
582
|
-
<em class="default">(defaults to: <tt>{
|
656
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
583
657
|
|
584
658
|
|
585
659
|
—
|
586
|
-
<div class='inline'>
|
587
|
-
|
660
|
+
<div class='inline'><p>
|
661
|
+
additional http headers
|
662
|
+
</p>
|
588
663
|
</div>
|
589
664
|
|
590
665
|
</li>
|
@@ -604,8 +679,9 @@
|
|
604
679
|
|
605
680
|
</span>
|
606
681
|
|
607
|
-
— <div class='inline'>
|
608
|
-
|
682
|
+
— <div class='inline'><p>
|
683
|
+
Sort results
|
684
|
+
</p>
|
609
685
|
</div>
|
610
686
|
|
611
687
|
</li>
|
@@ -617,8 +693,9 @@
|
|
617
693
|
|
618
694
|
</span>
|
619
695
|
|
620
|
-
— <div class='inline'>
|
621
|
-
|
696
|
+
— <div class='inline'><p>
|
697
|
+
Paginate results
|
698
|
+
</p>
|
622
699
|
</div>
|
623
700
|
|
624
701
|
</li>
|
@@ -630,8 +707,9 @@
|
|
630
707
|
|
631
708
|
</span>
|
632
709
|
|
633
|
-
— <div class='inline'>
|
634
|
-
|
710
|
+
— <div class='inline'><p>
|
711
|
+
Number of entries per request
|
712
|
+
</p>
|
635
713
|
</div>
|
636
714
|
|
637
715
|
</li>
|
@@ -643,8 +721,9 @@
|
|
643
721
|
|
644
722
|
</span>
|
645
723
|
|
646
|
-
— <div class='inline'>
|
647
|
-
|
724
|
+
— <div class='inline'><p>
|
725
|
+
Filter results
|
726
|
+
</p>
|
648
727
|
</div>
|
649
728
|
|
650
729
|
</li>
|
@@ -654,6 +733,25 @@
|
|
654
733
|
|
655
734
|
|
656
735
|
|
736
|
+
<p class="tag_title">Returns:</p>
|
737
|
+
<ul class="return">
|
738
|
+
|
739
|
+
<li>
|
740
|
+
|
741
|
+
|
742
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
743
|
+
|
744
|
+
|
745
|
+
|
746
|
+
—
|
747
|
+
<div class='inline'><p>
|
748
|
+
First item: parsed data; second item: raw body
|
749
|
+
</p>
|
750
|
+
</div>
|
751
|
+
|
752
|
+
</li>
|
753
|
+
|
754
|
+
</ul>
|
657
755
|
|
658
756
|
</div><table class="source_code">
|
659
757
|
<tr>
|
@@ -661,20 +759,17 @@
|
|
661
759
|
<pre class="lines">
|
662
760
|
|
663
761
|
|
664
|
-
15
|
665
762
|
16
|
666
763
|
17
|
667
|
-
18
|
668
|
-
19</pre>
|
764
|
+
18</pre>
|
669
765
|
</td>
|
670
766
|
<td>
|
671
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line
|
767
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line 16</span>
|
672
768
|
|
673
|
-
<span class='kw'>def</span> <span class='
|
674
|
-
<span class='
|
675
|
-
|
676
|
-
|
677
|
-
<span class='kw'>end</span></pre>
|
769
|
+
<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>
|
770
|
+
<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>
|
771
|
+
<span class='rubyid_end end kw'>end</span>
|
772
|
+
</pre>
|
678
773
|
</td>
|
679
774
|
</tr>
|
680
775
|
</table>
|
@@ -683,7 +778,7 @@
|
|
683
778
|
<div class="method_details ">
|
684
779
|
<h3 class="signature " id="show-instance_method">
|
685
780
|
|
686
|
-
- (<tt>
|
781
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
687
782
|
|
688
783
|
|
689
784
|
|
@@ -691,7 +786,10 @@
|
|
691
786
|
|
692
787
|
</h3><div class="docstring">
|
693
788
|
<div class="discussion">
|
694
|
-
|
789
|
+
<p>
|
790
|
+
First item: parsed data; second item: raw body
|
791
|
+
</p>
|
792
|
+
|
695
793
|
|
696
794
|
</div>
|
697
795
|
</div>
|
@@ -707,12 +805,13 @@
|
|
707
805
|
<span class='type'>(<tt>Hash</tt>)</span>
|
708
806
|
|
709
807
|
|
710
|
-
<em class="default">(defaults to: <tt>{
|
808
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
711
809
|
|
712
810
|
|
713
811
|
—
|
714
|
-
<div class='inline'>
|
715
|
-
|
812
|
+
<div class='inline'><p>
|
813
|
+
a hash of params to be passed to the service
|
814
|
+
</p>
|
716
815
|
</div>
|
717
816
|
|
718
817
|
</li>
|
@@ -725,12 +824,13 @@
|
|
725
824
|
<span class='type'>(<tt>Hash</tt>)</span>
|
726
825
|
|
727
826
|
|
728
|
-
<em class="default">(defaults to: <tt>{
|
827
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
729
828
|
|
730
829
|
|
731
830
|
—
|
732
|
-
<div class='inline'>
|
733
|
-
|
831
|
+
<div class='inline'><p>
|
832
|
+
additional http headers
|
833
|
+
</p>
|
734
834
|
</div>
|
735
835
|
|
736
836
|
</li>
|
@@ -757,6 +857,25 @@
|
|
757
857
|
|
758
858
|
|
759
859
|
|
860
|
+
<p class="tag_title">Returns:</p>
|
861
|
+
<ul class="return">
|
862
|
+
|
863
|
+
<li>
|
864
|
+
|
865
|
+
|
866
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
—
|
871
|
+
<div class='inline'><p>
|
872
|
+
First item: parsed data; second item: raw body
|
873
|
+
</p>
|
874
|
+
</div>
|
875
|
+
|
876
|
+
</li>
|
877
|
+
|
878
|
+
</ul>
|
760
879
|
|
761
880
|
</div><table class="source_code">
|
762
881
|
<tr>
|
@@ -766,18 +885,15 @@
|
|
766
885
|
|
767
886
|
25
|
768
887
|
26
|
769
|
-
27
|
770
|
-
28
|
771
|
-
29</pre>
|
888
|
+
27</pre>
|
772
889
|
</td>
|
773
890
|
<td>
|
774
891
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line 25</span>
|
775
892
|
|
776
|
-
<span class='kw'>def</span> <span class='
|
777
|
-
<span class='
|
778
|
-
|
779
|
-
|
780
|
-
<span class='kw'>end</span></pre>
|
893
|
+
<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>
|
894
|
+
<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>
|
895
|
+
<span class='rubyid_end end kw'>end</span>
|
896
|
+
</pre>
|
781
897
|
</td>
|
782
898
|
</tr>
|
783
899
|
</table>
|
@@ -786,7 +902,7 @@
|
|
786
902
|
<div class="method_details ">
|
787
903
|
<h3 class="signature " id="update-instance_method">
|
788
904
|
|
789
|
-
- (<tt>
|
905
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
790
906
|
|
791
907
|
|
792
908
|
|
@@ -794,7 +910,10 @@
|
|
794
910
|
|
795
911
|
</h3><div class="docstring">
|
796
912
|
<div class="discussion">
|
797
|
-
|
913
|
+
<p>
|
914
|
+
First item: parsed data; second item: raw body
|
915
|
+
</p>
|
916
|
+
|
798
917
|
|
799
918
|
</div>
|
800
919
|
</div>
|
@@ -810,12 +929,13 @@
|
|
810
929
|
<span class='type'>(<tt>Hash</tt>)</span>
|
811
930
|
|
812
931
|
|
813
|
-
<em class="default">(defaults to: <tt>{
|
932
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
814
933
|
|
815
934
|
|
816
935
|
—
|
817
|
-
<div class='inline'>
|
818
|
-
|
936
|
+
<div class='inline'><p>
|
937
|
+
a hash of params to be passed to the service
|
938
|
+
</p>
|
819
939
|
</div>
|
820
940
|
|
821
941
|
</li>
|
@@ -828,12 +948,13 @@
|
|
828
948
|
<span class='type'>(<tt>Hash</tt>)</span>
|
829
949
|
|
830
950
|
|
831
|
-
<em class="default">(defaults to: <tt>{
|
951
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
832
952
|
|
833
953
|
|
834
954
|
—
|
835
|
-
<div class='inline'>
|
836
|
-
|
955
|
+
<div class='inline'><p>
|
956
|
+
additional http headers
|
957
|
+
</p>
|
837
958
|
</div>
|
838
959
|
|
839
960
|
</li>
|
@@ -862,29 +983,41 @@
|
|
862
983
|
|
863
984
|
</span>
|
864
985
|
|
865
|
-
— <div class='inline'>
|
866
|
-
|
867
|
-
|
868
|
-
<
|
869
|
-
|
870
|
-
|
871
|
-
</li
|
872
|
-
<
|
873
|
-
|
874
|
-
|
875
|
-
|
876
|
-
|
877
|
-
</li
|
878
|
-
<
|
879
|
-
|
880
|
-
|
881
|
-
|
882
|
-
|
883
|
-
</li
|
884
|
-
<
|
885
|
-
|
886
|
-
|
887
|
-
|
986
|
+
— <div class='inline'><p>
|
987
|
+
allowed keys are:
|
988
|
+
</p>
|
989
|
+
<ul>
|
990
|
+
<li>architecture_id [String]
|
991
|
+
|
992
|
+
</li>
|
993
|
+
<li>domain_id [String]
|
994
|
+
|
995
|
+
</li>
|
996
|
+
<li>environment_id [String]
|
997
|
+
|
998
|
+
</li>
|
999
|
+
<li>medium_id [String]
|
1000
|
+
|
1001
|
+
</li>
|
1002
|
+
<li>operatingsystem_id [String]
|
1003
|
+
|
1004
|
+
</li>
|
1005
|
+
<li>ptable_id [String]
|
1006
|
+
|
1007
|
+
</li>
|
1008
|
+
<li>puppet_ca_proxy_id [String]
|
1009
|
+
|
1010
|
+
</li>
|
1011
|
+
<li>puppet_proxy_id [String]
|
1012
|
+
|
1013
|
+
</li>
|
1014
|
+
<li>subnet_id [String]
|
1015
|
+
|
1016
|
+
</li>
|
1017
|
+
<li>name [String]
|
1018
|
+
|
1019
|
+
</li>
|
1020
|
+
</ul>
|
888
1021
|
</div>
|
889
1022
|
|
890
1023
|
</li>
|
@@ -894,6 +1027,25 @@
|
|
894
1027
|
|
895
1028
|
|
896
1029
|
|
1030
|
+
<p class="tag_title">Returns:</p>
|
1031
|
+
<ul class="return">
|
1032
|
+
|
1033
|
+
<li>
|
1034
|
+
|
1035
|
+
|
1036
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
—
|
1041
|
+
<div class='inline'><p>
|
1042
|
+
First item: parsed data; second item: raw body
|
1043
|
+
</p>
|
1044
|
+
</div>
|
1045
|
+
|
1046
|
+
</li>
|
1047
|
+
|
1048
|
+
</ul>
|
897
1049
|
|
898
1050
|
</div><table class="source_code">
|
899
1051
|
<tr>
|
@@ -901,20 +1053,17 @@
|
|
901
1053
|
<pre class="lines">
|
902
1054
|
|
903
1055
|
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
71
|
908
|
-
72</pre>
|
1056
|
+
66
|
1057
|
+
67
|
1058
|
+
68</pre>
|
909
1059
|
</td>
|
910
1060
|
<td>
|
911
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line
|
1061
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/hostgroup.rb', line 66</span>
|
912
1062
|
|
913
|
-
<span class='kw'>def</span> <span class='
|
914
|
-
<span class='
|
915
|
-
|
916
|
-
|
917
|
-
<span class='kw'>end</span></pre>
|
1063
|
+
<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>
|
1064
|
+
<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>
|
1065
|
+
<span class='rubyid_end end kw'>end</span>
|
1066
|
+
</pre>
|
918
1067
|
</td>
|
919
1068
|
</tr>
|
920
1069
|
</table>
|
@@ -925,9 +1074,9 @@
|
|
925
1074
|
</div>
|
926
1075
|
|
927
1076
|
<div id="footer">
|
928
|
-
Generated on
|
1077
|
+
Generated on Tue Mar 19 09:50:25 2013 by
|
929
1078
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
930
|
-
0.8.
|
1079
|
+
0.8.5.2 (ruby-1.8.7).
|
931
1080
|
</div>
|
932
1081
|
|
933
1082
|
</body>
|