foreman_api 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- 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::Host
|
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="#status-instance_method" title="#status (instance method)">- (
|
253
|
+
<a href="#status-instance_method" title="#status (instance method)">- (Array) <strong>status</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
|
|
@@ -260,7 +275,7 @@
|
|
260
275
|
<li class="public ">
|
261
276
|
<span class="summary_signature">
|
262
277
|
|
263
|
-
<a href="#update-instance_method" title="#update (instance method)">- (
|
278
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
|
264
279
|
|
265
280
|
|
266
281
|
|
@@ -274,7 +289,10 @@
|
|
274
289
|
|
275
290
|
|
276
291
|
|
277
|
-
<span class="summary_desc"><div class='inline'
|
292
|
+
<span class="summary_desc"><div class='inline'><p>
|
293
|
+
First item: parsed data; second item: raw body.
|
294
|
+
</p>
|
295
|
+
</div></span>
|
278
296
|
|
279
297
|
</li>
|
280
298
|
|
@@ -311,9 +329,10 @@
|
|
311
329
|
<td>
|
312
330
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 4</span>
|
313
331
|
|
314
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='
|
315
|
-
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='
|
316
|
-
<span class='kw'>end</span
|
332
|
+
<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>
|
333
|
+
<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'>"hosts"</span><span class='rbrack token'>]</span>
|
334
|
+
<span class='rubyid_end end kw'>end</span>
|
335
|
+
</pre>
|
317
336
|
</td>
|
318
337
|
</tr>
|
319
338
|
</table>
|
@@ -328,7 +347,7 @@
|
|
328
347
|
<div class="method_details first">
|
329
348
|
<h3 class="signature first" id="create-instance_method">
|
330
349
|
|
331
|
-
- (<tt>
|
350
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
332
351
|
|
333
352
|
|
334
353
|
|
@@ -336,7 +355,10 @@
|
|
336
355
|
|
337
356
|
</h3><div class="docstring">
|
338
357
|
<div class="discussion">
|
339
|
-
|
358
|
+
<p>
|
359
|
+
First item: parsed data; second item: raw body
|
360
|
+
</p>
|
361
|
+
|
340
362
|
|
341
363
|
</div>
|
342
364
|
</div>
|
@@ -352,12 +374,13 @@
|
|
352
374
|
<span class='type'>(<tt>Hash</tt>)</span>
|
353
375
|
|
354
376
|
|
355
|
-
<em class="default">(defaults to: <tt>{
|
377
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
356
378
|
|
357
379
|
|
358
380
|
—
|
359
|
-
<div class='inline'>
|
360
|
-
|
381
|
+
<div class='inline'><p>
|
382
|
+
a hash of params to be passed to the service
|
383
|
+
</p>
|
361
384
|
</div>
|
362
385
|
|
363
386
|
</li>
|
@@ -370,12 +393,13 @@
|
|
370
393
|
<span class='type'>(<tt>Hash</tt>)</span>
|
371
394
|
|
372
395
|
|
373
|
-
<em class="default">(defaults to: <tt>{
|
396
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
374
397
|
|
375
398
|
|
376
399
|
—
|
377
|
-
<div class='inline'>
|
378
|
-
|
400
|
+
<div class='inline'><p>
|
401
|
+
additional http headers
|
402
|
+
</p>
|
379
403
|
</div>
|
380
404
|
|
381
405
|
</li>
|
@@ -395,45 +419,65 @@
|
|
395
419
|
|
396
420
|
</span>
|
397
421
|
|
398
|
-
— <div class='inline'>
|
399
|
-
|
400
|
-
|
401
|
-
<
|
402
|
-
|
403
|
-
|
404
|
-
</li
|
405
|
-
<
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
</li
|
411
|
-
<
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
</li
|
417
|
-
<
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
</li
|
423
|
-
<
|
424
|
-
|
425
|
-
|
426
|
-
|
427
|
-
|
428
|
-
</li
|
429
|
-
<
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
</li
|
435
|
-
<
|
436
|
-
|
422
|
+
— <div class='inline'><p>
|
423
|
+
allowed keys are:
|
424
|
+
</p>
|
425
|
+
<ul>
|
426
|
+
<li>architecture_id [String]
|
427
|
+
|
428
|
+
</li>
|
429
|
+
<li>domain_id [String]
|
430
|
+
|
431
|
+
</li>
|
432
|
+
<li>environment_id [String]
|
433
|
+
|
434
|
+
</li>
|
435
|
+
<li>hostgroup_id [String]
|
436
|
+
|
437
|
+
</li>
|
438
|
+
<li>image_id [String]
|
439
|
+
|
440
|
+
</li>
|
441
|
+
<li>medium_id [String]
|
442
|
+
|
443
|
+
</li>
|
444
|
+
<li>model_id_id [String]
|
445
|
+
|
446
|
+
</li>
|
447
|
+
<li>operatingsystem_id [String]
|
448
|
+
|
449
|
+
</li>
|
450
|
+
<li>owner_id [String]
|
451
|
+
|
452
|
+
</li>
|
453
|
+
<li>ptable_id [String]
|
454
|
+
|
455
|
+
</li>
|
456
|
+
<li>puppet_ca_proxy_id [String]
|
457
|
+
|
458
|
+
</li>
|
459
|
+
<li>puppet_proxy_id [String]
|
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>
|
437
481
|
</div>
|
438
482
|
|
439
483
|
</li>
|
@@ -443,6 +487,25 @@
|
|
443
487
|
|
444
488
|
|
445
489
|
|
490
|
+
<p class="tag_title">Returns:</p>
|
491
|
+
<ul class="return">
|
492
|
+
|
493
|
+
<li>
|
494
|
+
|
495
|
+
|
496
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
497
|
+
|
498
|
+
|
499
|
+
|
500
|
+
—
|
501
|
+
<div class='inline'><p>
|
502
|
+
First item: parsed data; second item: raw body
|
503
|
+
</p>
|
504
|
+
</div>
|
505
|
+
|
506
|
+
</li>
|
507
|
+
|
508
|
+
</ul>
|
446
509
|
|
447
510
|
</div><table class="source_code">
|
448
511
|
<tr>
|
@@ -450,20 +513,17 @@
|
|
450
513
|
<pre class="lines">
|
451
514
|
|
452
515
|
|
516
|
+
53
|
453
517
|
54
|
454
|
-
55
|
455
|
-
56
|
456
|
-
57
|
457
|
-
58</pre>
|
518
|
+
55</pre>
|
458
519
|
</td>
|
459
520
|
<td>
|
460
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line
|
521
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 53</span>
|
461
522
|
|
462
|
-
<span class='kw'>def</span> <span class='
|
463
|
-
<span class='
|
464
|
-
|
465
|
-
|
466
|
-
<span class='kw'>end</span></pre>
|
523
|
+
<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>
|
524
|
+
<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>
|
525
|
+
<span class='rubyid_end end kw'>end</span>
|
526
|
+
</pre>
|
467
527
|
</td>
|
468
528
|
</tr>
|
469
529
|
</table>
|
@@ -472,7 +532,7 @@
|
|
472
532
|
<div class="method_details ">
|
473
533
|
<h3 class="signature " id="destroy-instance_method">
|
474
534
|
|
475
|
-
- (<tt>
|
535
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
476
536
|
|
477
537
|
|
478
538
|
|
@@ -480,7 +540,10 @@
|
|
480
540
|
|
481
541
|
</h3><div class="docstring">
|
482
542
|
<div class="discussion">
|
483
|
-
|
543
|
+
<p>
|
544
|
+
First item: parsed data; second item: raw body
|
545
|
+
</p>
|
546
|
+
|
484
547
|
|
485
548
|
</div>
|
486
549
|
</div>
|
@@ -496,12 +559,13 @@
|
|
496
559
|
<span class='type'>(<tt>Hash</tt>)</span>
|
497
560
|
|
498
561
|
|
499
|
-
<em class="default">(defaults to: <tt>{
|
562
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
500
563
|
|
501
564
|
|
502
565
|
—
|
503
|
-
<div class='inline'>
|
504
|
-
|
566
|
+
<div class='inline'><p>
|
567
|
+
a hash of params to be passed to the service
|
568
|
+
</p>
|
505
569
|
</div>
|
506
570
|
|
507
571
|
</li>
|
@@ -514,12 +578,13 @@
|
|
514
578
|
<span class='type'>(<tt>Hash</tt>)</span>
|
515
579
|
|
516
580
|
|
517
|
-
<em class="default">(defaults to: <tt>{
|
581
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
518
582
|
|
519
583
|
|
520
584
|
—
|
521
|
-
<div class='inline'>
|
522
|
-
|
585
|
+
<div class='inline'><p>
|
586
|
+
additional http headers
|
587
|
+
</p>
|
523
588
|
</div>
|
524
589
|
|
525
590
|
</li>
|
@@ -546,6 +611,25 @@
|
|
546
611
|
|
547
612
|
|
548
613
|
|
614
|
+
<p class="tag_title">Returns:</p>
|
615
|
+
<ul class="return">
|
616
|
+
|
617
|
+
<li>
|
618
|
+
|
619
|
+
|
620
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
—
|
625
|
+
<div class='inline'><p>
|
626
|
+
First item: parsed data; second item: raw body
|
627
|
+
</p>
|
628
|
+
</div>
|
629
|
+
|
630
|
+
</li>
|
631
|
+
|
632
|
+
</ul>
|
549
633
|
|
550
634
|
</div><table class="source_code">
|
551
635
|
<tr>
|
@@ -553,20 +637,17 @@
|
|
553
637
|
<pre class="lines">
|
554
638
|
|
555
639
|
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
97
|
560
|
-
98</pre>
|
640
|
+
91
|
641
|
+
92
|
642
|
+
93</pre>
|
561
643
|
</td>
|
562
644
|
<td>
|
563
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line
|
645
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 91</span>
|
564
646
|
|
565
|
-
<span class='kw'>def</span> <span class='
|
566
|
-
<span class='
|
567
|
-
|
568
|
-
|
569
|
-
<span class='kw'>end</span></pre>
|
647
|
+
<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>
|
648
|
+
<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>
|
649
|
+
<span class='rubyid_end end kw'>end</span>
|
650
|
+
</pre>
|
570
651
|
</td>
|
571
652
|
</tr>
|
572
653
|
</table>
|
@@ -575,7 +656,7 @@
|
|
575
656
|
<div class="method_details ">
|
576
657
|
<h3 class="signature " id="index-instance_method">
|
577
658
|
|
578
|
-
- (<tt>
|
659
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
579
660
|
|
580
661
|
|
581
662
|
|
@@ -583,7 +664,10 @@
|
|
583
664
|
|
584
665
|
</h3><div class="docstring">
|
585
666
|
<div class="discussion">
|
586
|
-
|
667
|
+
<p>
|
668
|
+
First item: parsed data; second item: raw body
|
669
|
+
</p>
|
670
|
+
|
587
671
|
|
588
672
|
</div>
|
589
673
|
</div>
|
@@ -599,12 +683,13 @@
|
|
599
683
|
<span class='type'>(<tt>Hash</tt>)</span>
|
600
684
|
|
601
685
|
|
602
|
-
<em class="default">(defaults to: <tt>{
|
686
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
603
687
|
|
604
688
|
|
605
689
|
—
|
606
|
-
<div class='inline'>
|
607
|
-
|
690
|
+
<div class='inline'><p>
|
691
|
+
a hash of params to be passed to the service
|
692
|
+
</p>
|
608
693
|
</div>
|
609
694
|
|
610
695
|
</li>
|
@@ -617,12 +702,13 @@
|
|
617
702
|
<span class='type'>(<tt>Hash</tt>)</span>
|
618
703
|
|
619
704
|
|
620
|
-
<em class="default">(defaults to: <tt>{
|
705
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
621
706
|
|
622
707
|
|
623
708
|
—
|
624
|
-
<div class='inline'>
|
625
|
-
|
709
|
+
<div class='inline'><p>
|
710
|
+
additional http headers
|
711
|
+
</p>
|
626
712
|
</div>
|
627
713
|
|
628
714
|
</li>
|
@@ -642,8 +728,9 @@
|
|
642
728
|
|
643
729
|
</span>
|
644
730
|
|
645
|
-
— <div class='inline'>
|
646
|
-
|
731
|
+
— <div class='inline'><p>
|
732
|
+
Sort results
|
733
|
+
</p>
|
647
734
|
</div>
|
648
735
|
|
649
736
|
</li>
|
@@ -655,8 +742,9 @@
|
|
655
742
|
|
656
743
|
</span>
|
657
744
|
|
658
|
-
— <div class='inline'>
|
659
|
-
|
745
|
+
— <div class='inline'><p>
|
746
|
+
Paginate results
|
747
|
+
</p>
|
660
748
|
</div>
|
661
749
|
|
662
750
|
</li>
|
@@ -668,8 +756,9 @@
|
|
668
756
|
|
669
757
|
</span>
|
670
758
|
|
671
|
-
— <div class='inline'>
|
672
|
-
|
759
|
+
— <div class='inline'><p>
|
760
|
+
Number of entries per request
|
761
|
+
</p>
|
673
762
|
</div>
|
674
763
|
|
675
764
|
</li>
|
@@ -681,8 +770,9 @@
|
|
681
770
|
|
682
771
|
</span>
|
683
772
|
|
684
|
-
— <div class='inline'>
|
685
|
-
|
773
|
+
— <div class='inline'><p>
|
774
|
+
Filter results
|
775
|
+
</p>
|
686
776
|
</div>
|
687
777
|
|
688
778
|
</li>
|
@@ -692,6 +782,25 @@
|
|
692
782
|
|
693
783
|
|
694
784
|
|
785
|
+
<p class="tag_title">Returns:</p>
|
786
|
+
<ul class="return">
|
787
|
+
|
788
|
+
<li>
|
789
|
+
|
790
|
+
|
791
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
792
|
+
|
793
|
+
|
794
|
+
|
795
|
+
—
|
796
|
+
<div class='inline'><p>
|
797
|
+
First item: parsed data; second item: raw body
|
798
|
+
</p>
|
799
|
+
</div>
|
800
|
+
|
801
|
+
</li>
|
802
|
+
|
803
|
+
</ul>
|
695
804
|
|
696
805
|
</div><table class="source_code">
|
697
806
|
<tr>
|
@@ -699,20 +808,17 @@
|
|
699
808
|
<pre class="lines">
|
700
809
|
|
701
810
|
|
702
|
-
15
|
703
811
|
16
|
704
812
|
17
|
705
|
-
18
|
706
|
-
19</pre>
|
813
|
+
18</pre>
|
707
814
|
</td>
|
708
815
|
<td>
|
709
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line
|
816
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 16</span>
|
710
817
|
|
711
|
-
<span class='kw'>def</span> <span class='
|
712
|
-
<span class='
|
713
|
-
|
714
|
-
|
715
|
-
<span class='kw'>end</span></pre>
|
818
|
+
<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>
|
819
|
+
<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>
|
820
|
+
<span class='rubyid_end end kw'>end</span>
|
821
|
+
</pre>
|
716
822
|
</td>
|
717
823
|
</tr>
|
718
824
|
</table>
|
@@ -721,7 +827,7 @@
|
|
721
827
|
<div class="method_details ">
|
722
828
|
<h3 class="signature " id="show-instance_method">
|
723
829
|
|
724
|
-
- (<tt>
|
830
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
725
831
|
|
726
832
|
|
727
833
|
|
@@ -729,7 +835,10 @@
|
|
729
835
|
|
730
836
|
</h3><div class="docstring">
|
731
837
|
<div class="discussion">
|
732
|
-
|
838
|
+
<p>
|
839
|
+
First item: parsed data; second item: raw body
|
840
|
+
</p>
|
841
|
+
|
733
842
|
|
734
843
|
</div>
|
735
844
|
</div>
|
@@ -745,12 +854,13 @@
|
|
745
854
|
<span class='type'>(<tt>Hash</tt>)</span>
|
746
855
|
|
747
856
|
|
748
|
-
<em class="default">(defaults to: <tt>{
|
857
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
749
858
|
|
750
859
|
|
751
860
|
—
|
752
|
-
<div class='inline'>
|
753
|
-
|
861
|
+
<div class='inline'><p>
|
862
|
+
a hash of params to be passed to the service
|
863
|
+
</p>
|
754
864
|
</div>
|
755
865
|
|
756
866
|
</li>
|
@@ -763,12 +873,13 @@
|
|
763
873
|
<span class='type'>(<tt>Hash</tt>)</span>
|
764
874
|
|
765
875
|
|
766
|
-
<em class="default">(defaults to: <tt>{
|
876
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
767
877
|
|
768
878
|
|
769
879
|
—
|
770
|
-
<div class='inline'>
|
771
|
-
|
880
|
+
<div class='inline'><p>
|
881
|
+
additional http headers
|
882
|
+
</p>
|
772
883
|
</div>
|
773
884
|
|
774
885
|
</li>
|
@@ -795,6 +906,25 @@
|
|
795
906
|
|
796
907
|
|
797
908
|
|
909
|
+
<p class="tag_title">Returns:</p>
|
910
|
+
<ul class="return">
|
911
|
+
|
912
|
+
<li>
|
913
|
+
|
914
|
+
|
915
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
916
|
+
|
917
|
+
|
918
|
+
|
919
|
+
—
|
920
|
+
<div class='inline'><p>
|
921
|
+
First item: parsed data; second item: raw body
|
922
|
+
</p>
|
923
|
+
</div>
|
924
|
+
|
925
|
+
</li>
|
926
|
+
|
927
|
+
</ul>
|
798
928
|
|
799
929
|
</div><table class="source_code">
|
800
930
|
<tr>
|
@@ -804,18 +934,15 @@
|
|
804
934
|
|
805
935
|
25
|
806
936
|
26
|
807
|
-
27
|
808
|
-
28
|
809
|
-
29</pre>
|
937
|
+
27</pre>
|
810
938
|
</td>
|
811
939
|
<td>
|
812
940
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 25</span>
|
813
941
|
|
814
|
-
<span class='kw'>def</span> <span class='
|
815
|
-
<span class='
|
816
|
-
|
817
|
-
|
818
|
-
<span class='kw'>end</span></pre>
|
942
|
+
<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>
|
943
|
+
<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>
|
944
|
+
<span class='rubyid_end end kw'>end</span>
|
945
|
+
</pre>
|
819
946
|
</td>
|
820
947
|
</tr>
|
821
948
|
</table>
|
@@ -824,7 +951,7 @@
|
|
824
951
|
<div class="method_details ">
|
825
952
|
<h3 class="signature " id="status-instance_method">
|
826
953
|
|
827
|
-
- (<tt>
|
954
|
+
- (<tt>Array</tt>) <strong>status</strong>(params = {}, headers = {})
|
828
955
|
|
829
956
|
|
830
957
|
|
@@ -832,7 +959,10 @@
|
|
832
959
|
|
833
960
|
</h3><div class="docstring">
|
834
961
|
<div class="discussion">
|
835
|
-
|
962
|
+
<p>
|
963
|
+
First item: parsed data; second item: raw body
|
964
|
+
</p>
|
965
|
+
|
836
966
|
|
837
967
|
</div>
|
838
968
|
</div>
|
@@ -848,12 +978,13 @@
|
|
848
978
|
<span class='type'>(<tt>Hash</tt>)</span>
|
849
979
|
|
850
980
|
|
851
|
-
<em class="default">(defaults to: <tt>{
|
981
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
852
982
|
|
853
983
|
|
854
984
|
—
|
855
|
-
<div class='inline'>
|
856
|
-
|
985
|
+
<div class='inline'><p>
|
986
|
+
a hash of params to be passed to the service
|
987
|
+
</p>
|
857
988
|
</div>
|
858
989
|
|
859
990
|
</li>
|
@@ -866,12 +997,13 @@
|
|
866
997
|
<span class='type'>(<tt>Hash</tt>)</span>
|
867
998
|
|
868
999
|
|
869
|
-
<em class="default">(defaults to: <tt>{
|
1000
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
870
1001
|
|
871
1002
|
|
872
1003
|
—
|
873
|
-
<div class='inline'>
|
874
|
-
|
1004
|
+
<div class='inline'><p>
|
1005
|
+
additional http headers
|
1006
|
+
</p>
|
875
1007
|
</div>
|
876
1008
|
|
877
1009
|
</li>
|
@@ -898,6 +1030,25 @@
|
|
898
1030
|
|
899
1031
|
|
900
1032
|
|
1033
|
+
<p class="tag_title">Returns:</p>
|
1034
|
+
<ul class="return">
|
1035
|
+
|
1036
|
+
<li>
|
1037
|
+
|
1038
|
+
|
1039
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
—
|
1044
|
+
<div class='inline'><p>
|
1045
|
+
First item: parsed data; second item: raw body
|
1046
|
+
</p>
|
1047
|
+
</div>
|
1048
|
+
|
1049
|
+
</li>
|
1050
|
+
|
1051
|
+
</ul>
|
901
1052
|
|
902
1053
|
</div><table class="source_code">
|
903
1054
|
<tr>
|
@@ -905,20 +1056,17 @@
|
|
905
1056
|
<pre class="lines">
|
906
1057
|
|
907
1058
|
|
908
|
-
|
909
|
-
|
910
|
-
|
911
|
-
107
|
912
|
-
108</pre>
|
1059
|
+
100
|
1060
|
+
101
|
1061
|
+
102</pre>
|
913
1062
|
</td>
|
914
1063
|
<td>
|
915
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line
|
1064
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 100</span>
|
916
1065
|
|
917
|
-
<span class='kw'>def</span> <span class='
|
918
|
-
<span class='
|
919
|
-
|
920
|
-
|
921
|
-
<span class='kw'>end</span></pre>
|
1066
|
+
<span class='rubyid_def def kw'>def</span> <span class='rubyid_status identifier id'>status</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>
|
1067
|
+
<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>
|
1068
|
+
<span class='rubyid_end end kw'>end</span>
|
1069
|
+
</pre>
|
922
1070
|
</td>
|
923
1071
|
</tr>
|
924
1072
|
</table>
|
@@ -927,7 +1075,7 @@
|
|
927
1075
|
<div class="method_details ">
|
928
1076
|
<h3 class="signature " id="update-instance_method">
|
929
1077
|
|
930
|
-
- (<tt>
|
1078
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
931
1079
|
|
932
1080
|
|
933
1081
|
|
@@ -935,7 +1083,10 @@
|
|
935
1083
|
|
936
1084
|
</h3><div class="docstring">
|
937
1085
|
<div class="discussion">
|
938
|
-
|
1086
|
+
<p>
|
1087
|
+
First item: parsed data; second item: raw body
|
1088
|
+
</p>
|
1089
|
+
|
939
1090
|
|
940
1091
|
</div>
|
941
1092
|
</div>
|
@@ -951,12 +1102,13 @@
|
|
951
1102
|
<span class='type'>(<tt>Hash</tt>)</span>
|
952
1103
|
|
953
1104
|
|
954
|
-
<em class="default">(defaults to: <tt>{
|
1105
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
955
1106
|
|
956
1107
|
|
957
1108
|
—
|
958
|
-
<div class='inline'>
|
959
|
-
|
1109
|
+
<div class='inline'><p>
|
1110
|
+
a hash of params to be passed to the service
|
1111
|
+
</p>
|
960
1112
|
</div>
|
961
1113
|
|
962
1114
|
</li>
|
@@ -969,12 +1121,13 @@
|
|
969
1121
|
<span class='type'>(<tt>Hash</tt>)</span>
|
970
1122
|
|
971
1123
|
|
972
|
-
<em class="default">(defaults to: <tt>{
|
1124
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
973
1125
|
|
974
1126
|
|
975
1127
|
—
|
976
|
-
<div class='inline'>
|
977
|
-
|
1128
|
+
<div class='inline'><p>
|
1129
|
+
additional http headers
|
1130
|
+
</p>
|
978
1131
|
</div>
|
979
1132
|
|
980
1133
|
</li>
|
@@ -1003,45 +1156,65 @@
|
|
1003
1156
|
|
1004
1157
|
</span>
|
1005
1158
|
|
1006
|
-
— <div class='inline'>
|
1007
|
-
|
1008
|
-
|
1009
|
-
<
|
1010
|
-
|
1011
|
-
|
1012
|
-
</li
|
1013
|
-
<
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
</li
|
1019
|
-
<
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
</li
|
1025
|
-
<
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
</li
|
1031
|
-
<
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
</li
|
1037
|
-
<
|
1038
|
-
|
1039
|
-
|
1040
|
-
|
1041
|
-
|
1042
|
-
</li
|
1043
|
-
<
|
1044
|
-
|
1159
|
+
— <div class='inline'><p>
|
1160
|
+
allowed keys are:
|
1161
|
+
</p>
|
1162
|
+
<ul>
|
1163
|
+
<li>architecture_id [String]
|
1164
|
+
|
1165
|
+
</li>
|
1166
|
+
<li>domain_id [String]
|
1167
|
+
|
1168
|
+
</li>
|
1169
|
+
<li>environment_id [String]
|
1170
|
+
|
1171
|
+
</li>
|
1172
|
+
<li>hostgroup_id [String]
|
1173
|
+
|
1174
|
+
</li>
|
1175
|
+
<li>image_id [String]
|
1176
|
+
|
1177
|
+
</li>
|
1178
|
+
<li>medium_id [String]
|
1179
|
+
|
1180
|
+
</li>
|
1181
|
+
<li>model_id_id [String]
|
1182
|
+
|
1183
|
+
</li>
|
1184
|
+
<li>operatingsystem_id [String]
|
1185
|
+
|
1186
|
+
</li>
|
1187
|
+
<li>owner_id [String]
|
1188
|
+
|
1189
|
+
</li>
|
1190
|
+
<li>ptable_id [String]
|
1191
|
+
|
1192
|
+
</li>
|
1193
|
+
<li>puppet_ca_proxy_id [String]
|
1194
|
+
|
1195
|
+
</li>
|
1196
|
+
<li>puppet_proxy_id [String]
|
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>
|
1045
1218
|
</div>
|
1046
1219
|
|
1047
1220
|
</li>
|
@@ -1051,6 +1224,25 @@
|
|
1051
1224
|
|
1052
1225
|
|
1053
1226
|
|
1227
|
+
<p class="tag_title">Returns:</p>
|
1228
|
+
<ul class="return">
|
1229
|
+
|
1230
|
+
<li>
|
1231
|
+
|
1232
|
+
|
1233
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1234
|
+
|
1235
|
+
|
1236
|
+
|
1237
|
+
—
|
1238
|
+
<div class='inline'><p>
|
1239
|
+
First item: parsed data; second item: raw body
|
1240
|
+
</p>
|
1241
|
+
</div>
|
1242
|
+
|
1243
|
+
</li>
|
1244
|
+
|
1245
|
+
</ul>
|
1054
1246
|
|
1055
1247
|
</div><table class="source_code">
|
1056
1248
|
<tr>
|
@@ -1058,20 +1250,17 @@
|
|
1058
1250
|
<pre class="lines">
|
1059
1251
|
|
1060
1252
|
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
1064
|
-
87
|
1065
|
-
88</pre>
|
1253
|
+
82
|
1254
|
+
83
|
1255
|
+
84</pre>
|
1066
1256
|
</td>
|
1067
1257
|
<td>
|
1068
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line
|
1258
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 82</span>
|
1069
1259
|
|
1070
|
-
<span class='kw'>def</span> <span class='
|
1071
|
-
<span class='
|
1072
|
-
|
1073
|
-
|
1074
|
-
<span class='kw'>end</span></pre>
|
1260
|
+
<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>
|
1261
|
+
<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>
|
1262
|
+
<span class='rubyid_end end kw'>end</span>
|
1263
|
+
</pre>
|
1075
1264
|
</td>
|
1076
1265
|
</tr>
|
1077
1266
|
</table>
|
@@ -1082,9 +1271,9 @@
|
|
1082
1271
|
</div>
|
1083
1272
|
|
1084
1273
|
<div id="footer">
|
1085
|
-
Generated on
|
1274
|
+
Generated on Tue Mar 19 09:50:23 2013 by
|
1086
1275
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1087
|
-
0.8.
|
1276
|
+
0.8.5.2 (ruby-1.8.7).
|
1088
1277
|
</div>
|
1089
1278
|
|
1090
1279
|
</body>
|