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::Medium
|
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/medium.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'>"media"</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,22 +394,26 @@
|
|
373
394
|
|
374
395
|
</span>
|
375
396
|
|
376
|
-
— <div class='inline'>
|
377
|
-
|
378
|
-
|
379
|
-
<
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
version
|
390
|
-
$
|
391
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>name [String] Name of media
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>os_family [String] The family that the operating system belongs to.
|
405
|
+
available families: archlinux debian redhat solaris suse windows
|
406
|
+
|
407
|
+
</li>
|
408
|
+
<li>path [String] The path to the medium, can be a url or a valid nfs server
|
409
|
+
(exclusive of the architecture). for example
|
410
|
+
http://mirror.averse.net/centos/$version/os/$arch where $arch will be
|
411
|
+
substituted for the host&#8217;s actual os architecture and $version,
|
412
|
+
$major and $minor will be substituted for the version of the operating
|
413
|
+
system. solaris and debian media may also use $release.
|
414
|
+
|
415
|
+
</li>
|
416
|
+
</ul>
|
392
417
|
</div>
|
393
418
|
|
394
419
|
</li>
|
@@ -398,6 +423,25 @@ $release. ,</p>
|
|
398
423
|
|
399
424
|
|
400
425
|
|
426
|
+
<p class="tag_title">Returns:</p>
|
427
|
+
<ul class="return">
|
428
|
+
|
429
|
+
<li>
|
430
|
+
|
431
|
+
|
432
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
—
|
437
|
+
<div class='inline'><p>
|
438
|
+
First item: parsed data; second item: raw body
|
439
|
+
</p>
|
440
|
+
</div>
|
441
|
+
|
442
|
+
</li>
|
443
|
+
|
444
|
+
</ul>
|
401
445
|
|
402
446
|
</div><table class="source_code">
|
403
447
|
<tr>
|
@@ -405,20 +449,17 @@ $release. ,</p>
|
|
405
449
|
<pre class="lines">
|
406
450
|
|
407
451
|
|
452
|
+
38
|
408
453
|
39
|
409
|
-
40
|
410
|
-
41
|
411
|
-
42
|
412
|
-
43</pre>
|
454
|
+
40</pre>
|
413
455
|
</td>
|
414
456
|
<td>
|
415
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line
|
457
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line 38</span>
|
416
458
|
|
417
|
-
<span class='kw'>def</span> <span class='
|
418
|
-
<span class='
|
419
|
-
|
420
|
-
|
421
|
-
<span class='kw'>end</span></pre>
|
459
|
+
<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>
|
460
|
+
<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>
|
461
|
+
<span class='rubyid_end end kw'>end</span>
|
462
|
+
</pre>
|
422
463
|
</td>
|
423
464
|
</tr>
|
424
465
|
</table>
|
@@ -427,7 +468,7 @@ $release. ,</p>
|
|
427
468
|
<div class="method_details ">
|
428
469
|
<h3 class="signature " id="destroy-instance_method">
|
429
470
|
|
430
|
-
- (<tt>
|
471
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
431
472
|
|
432
473
|
|
433
474
|
|
@@ -435,7 +476,10 @@ $release. ,</p>
|
|
435
476
|
|
436
477
|
</h3><div class="docstring">
|
437
478
|
<div class="discussion">
|
438
|
-
|
479
|
+
<p>
|
480
|
+
First item: parsed data; second item: raw body
|
481
|
+
</p>
|
482
|
+
|
439
483
|
|
440
484
|
</div>
|
441
485
|
</div>
|
@@ -451,12 +495,13 @@ $release. ,</p>
|
|
451
495
|
<span class='type'>(<tt>Hash</tt>)</span>
|
452
496
|
|
453
497
|
|
454
|
-
<em class="default">(defaults to: <tt>{
|
498
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
455
499
|
|
456
500
|
|
457
501
|
—
|
458
|
-
<div class='inline'>
|
459
|
-
|
502
|
+
<div class='inline'><p>
|
503
|
+
a hash of params to be passed to the service
|
504
|
+
</p>
|
460
505
|
</div>
|
461
506
|
|
462
507
|
</li>
|
@@ -469,12 +514,13 @@ $release. ,</p>
|
|
469
514
|
<span class='type'>(<tt>Hash</tt>)</span>
|
470
515
|
|
471
516
|
|
472
|
-
<em class="default">(defaults to: <tt>{
|
517
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
473
518
|
|
474
519
|
|
475
520
|
—
|
476
|
-
<div class='inline'>
|
477
|
-
|
521
|
+
<div class='inline'><p>
|
522
|
+
additional http headers
|
523
|
+
</p>
|
478
524
|
</div>
|
479
525
|
|
480
526
|
</li>
|
@@ -501,6 +547,25 @@ $release. ,</p>
|
|
501
547
|
|
502
548
|
|
503
549
|
|
550
|
+
<p class="tag_title">Returns:</p>
|
551
|
+
<ul class="return">
|
552
|
+
|
553
|
+
<li>
|
554
|
+
|
555
|
+
|
556
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
557
|
+
|
558
|
+
|
559
|
+
|
560
|
+
—
|
561
|
+
<div class='inline'><p>
|
562
|
+
First item: parsed data; second item: raw body
|
563
|
+
</p>
|
564
|
+
</div>
|
565
|
+
|
566
|
+
</li>
|
567
|
+
|
568
|
+
</ul>
|
504
569
|
|
505
570
|
</div><table class="source_code">
|
506
571
|
<tr>
|
@@ -508,20 +573,17 @@ $release. ,</p>
|
|
508
573
|
<pre class="lines">
|
509
574
|
|
510
575
|
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
67
|
515
|
-
68</pre>
|
576
|
+
61
|
577
|
+
62
|
578
|
+
63</pre>
|
516
579
|
</td>
|
517
580
|
<td>
|
518
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line
|
581
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line 61</span>
|
519
582
|
|
520
|
-
<span class='kw'>def</span> <span class='
|
521
|
-
<span class='
|
522
|
-
|
523
|
-
|
524
|
-
<span class='kw'>end</span></pre>
|
583
|
+
<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>
|
584
|
+
<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>
|
585
|
+
<span class='rubyid_end end kw'>end</span>
|
586
|
+
</pre>
|
525
587
|
</td>
|
526
588
|
</tr>
|
527
589
|
</table>
|
@@ -530,7 +592,7 @@ $release. ,</p>
|
|
530
592
|
<div class="method_details ">
|
531
593
|
<h3 class="signature " id="index-instance_method">
|
532
594
|
|
533
|
-
- (<tt>
|
595
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
534
596
|
|
535
597
|
|
536
598
|
|
@@ -538,7 +600,10 @@ $release. ,</p>
|
|
538
600
|
|
539
601
|
</h3><div class="docstring">
|
540
602
|
<div class="discussion">
|
541
|
-
|
603
|
+
<p>
|
604
|
+
First item: parsed data; second item: raw body
|
605
|
+
</p>
|
606
|
+
|
542
607
|
|
543
608
|
</div>
|
544
609
|
</div>
|
@@ -554,12 +619,13 @@ $release. ,</p>
|
|
554
619
|
<span class='type'>(<tt>Hash</tt>)</span>
|
555
620
|
|
556
621
|
|
557
|
-
<em class="default">(defaults to: <tt>{
|
622
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
558
623
|
|
559
624
|
|
560
625
|
—
|
561
|
-
<div class='inline'>
|
562
|
-
|
626
|
+
<div class='inline'><p>
|
627
|
+
a hash of params to be passed to the service
|
628
|
+
</p>
|
563
629
|
</div>
|
564
630
|
|
565
631
|
</li>
|
@@ -572,12 +638,13 @@ $release. ,</p>
|
|
572
638
|
<span class='type'>(<tt>Hash</tt>)</span>
|
573
639
|
|
574
640
|
|
575
|
-
<em class="default">(defaults to: <tt>{
|
641
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
576
642
|
|
577
643
|
|
578
644
|
—
|
579
|
-
<div class='inline'>
|
580
|
-
|
645
|
+
<div class='inline'><p>
|
646
|
+
additional http headers
|
647
|
+
</p>
|
581
648
|
</div>
|
582
649
|
|
583
650
|
</li>
|
@@ -597,8 +664,9 @@ $release. ,</p>
|
|
597
664
|
|
598
665
|
</span>
|
599
666
|
|
600
|
-
— <div class='inline'>
|
601
|
-
|
667
|
+
— <div class='inline'><p>
|
668
|
+
For example, name asc, or name desc
|
669
|
+
</p>
|
602
670
|
</div>
|
603
671
|
|
604
672
|
</li>
|
@@ -610,8 +678,9 @@ $release. ,</p>
|
|
610
678
|
|
611
679
|
</span>
|
612
680
|
|
613
|
-
— <div class='inline'>
|
614
|
-
|
681
|
+
— <div class='inline'><p>
|
682
|
+
Paginate results
|
683
|
+
</p>
|
615
684
|
</div>
|
616
685
|
|
617
686
|
</li>
|
@@ -623,8 +692,9 @@ $release. ,</p>
|
|
623
692
|
|
624
693
|
</span>
|
625
694
|
|
626
|
-
— <div class='inline'>
|
627
|
-
|
695
|
+
— <div class='inline'><p>
|
696
|
+
Number of entries per request
|
697
|
+
</p>
|
628
698
|
</div>
|
629
699
|
|
630
700
|
</li>
|
@@ -636,8 +706,9 @@ $release. ,</p>
|
|
636
706
|
|
637
707
|
</span>
|
638
708
|
|
639
|
-
— <div class='inline'>
|
640
|
-
|
709
|
+
— <div class='inline'><p>
|
710
|
+
Filter results
|
711
|
+
</p>
|
641
712
|
</div>
|
642
713
|
|
643
714
|
</li>
|
@@ -647,6 +718,25 @@ $release. ,</p>
|
|
647
718
|
|
648
719
|
|
649
720
|
|
721
|
+
<p class="tag_title">Returns:</p>
|
722
|
+
<ul class="return">
|
723
|
+
|
724
|
+
<li>
|
725
|
+
|
726
|
+
|
727
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
728
|
+
|
729
|
+
|
730
|
+
|
731
|
+
—
|
732
|
+
<div class='inline'><p>
|
733
|
+
First item: parsed data; second item: raw body
|
734
|
+
</p>
|
735
|
+
</div>
|
736
|
+
|
737
|
+
</li>
|
738
|
+
|
739
|
+
</ul>
|
650
740
|
|
651
741
|
</div><table class="source_code">
|
652
742
|
<tr>
|
@@ -654,20 +744,17 @@ $release. ,</p>
|
|
654
744
|
<pre class="lines">
|
655
745
|
|
656
746
|
|
657
|
-
15
|
658
747
|
16
|
659
748
|
17
|
660
|
-
18
|
661
|
-
19</pre>
|
749
|
+
18</pre>
|
662
750
|
</td>
|
663
751
|
<td>
|
664
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line
|
752
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line 16</span>
|
665
753
|
|
666
|
-
<span class='kw'>def</span> <span class='
|
667
|
-
<span class='
|
668
|
-
|
669
|
-
|
670
|
-
<span class='kw'>end</span></pre>
|
754
|
+
<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>
|
755
|
+
<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>
|
756
|
+
<span class='rubyid_end end kw'>end</span>
|
757
|
+
</pre>
|
671
758
|
</td>
|
672
759
|
</tr>
|
673
760
|
</table>
|
@@ -676,7 +763,7 @@ $release. ,</p>
|
|
676
763
|
<div class="method_details ">
|
677
764
|
<h3 class="signature " id="show-instance_method">
|
678
765
|
|
679
|
-
- (<tt>
|
766
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
680
767
|
|
681
768
|
|
682
769
|
|
@@ -684,7 +771,10 @@ $release. ,</p>
|
|
684
771
|
|
685
772
|
</h3><div class="docstring">
|
686
773
|
<div class="discussion">
|
687
|
-
|
774
|
+
<p>
|
775
|
+
First item: parsed data; second item: raw body
|
776
|
+
</p>
|
777
|
+
|
688
778
|
|
689
779
|
</div>
|
690
780
|
</div>
|
@@ -700,12 +790,13 @@ $release. ,</p>
|
|
700
790
|
<span class='type'>(<tt>Hash</tt>)</span>
|
701
791
|
|
702
792
|
|
703
|
-
<em class="default">(defaults to: <tt>{
|
793
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
704
794
|
|
705
795
|
|
706
796
|
—
|
707
|
-
<div class='inline'>
|
708
|
-
|
797
|
+
<div class='inline'><p>
|
798
|
+
a hash of params to be passed to the service
|
799
|
+
</p>
|
709
800
|
</div>
|
710
801
|
|
711
802
|
</li>
|
@@ -718,12 +809,13 @@ $release. ,</p>
|
|
718
809
|
<span class='type'>(<tt>Hash</tt>)</span>
|
719
810
|
|
720
811
|
|
721
|
-
<em class="default">(defaults to: <tt>{
|
812
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
722
813
|
|
723
814
|
|
724
815
|
—
|
725
|
-
<div class='inline'>
|
726
|
-
|
816
|
+
<div class='inline'><p>
|
817
|
+
additional http headers
|
818
|
+
</p>
|
727
819
|
</div>
|
728
820
|
|
729
821
|
</li>
|
@@ -750,6 +842,25 @@ $release. ,</p>
|
|
750
842
|
|
751
843
|
|
752
844
|
|
845
|
+
<p class="tag_title">Returns:</p>
|
846
|
+
<ul class="return">
|
847
|
+
|
848
|
+
<li>
|
849
|
+
|
850
|
+
|
851
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
852
|
+
|
853
|
+
|
854
|
+
|
855
|
+
—
|
856
|
+
<div class='inline'><p>
|
857
|
+
First item: parsed data; second item: raw body
|
858
|
+
</p>
|
859
|
+
</div>
|
860
|
+
|
861
|
+
</li>
|
862
|
+
|
863
|
+
</ul>
|
753
864
|
|
754
865
|
</div><table class="source_code">
|
755
866
|
<tr>
|
@@ -759,18 +870,15 @@ $release. ,</p>
|
|
759
870
|
|
760
871
|
25
|
761
872
|
26
|
762
|
-
27
|
763
|
-
28
|
764
|
-
29</pre>
|
873
|
+
27</pre>
|
765
874
|
</td>
|
766
875
|
<td>
|
767
876
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line 25</span>
|
768
877
|
|
769
|
-
<span class='kw'>def</span> <span class='
|
770
|
-
<span class='
|
771
|
-
|
772
|
-
|
773
|
-
<span class='kw'>end</span></pre>
|
878
|
+
<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>
|
879
|
+
<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>
|
880
|
+
<span class='rubyid_end end kw'>end</span>
|
881
|
+
</pre>
|
774
882
|
</td>
|
775
883
|
</tr>
|
776
884
|
</table>
|
@@ -779,7 +887,7 @@ $release. ,</p>
|
|
779
887
|
<div class="method_details ">
|
780
888
|
<h3 class="signature " id="update-instance_method">
|
781
889
|
|
782
|
-
- (<tt>
|
890
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
783
891
|
|
784
892
|
|
785
893
|
|
@@ -787,7 +895,10 @@ $release. ,</p>
|
|
787
895
|
|
788
896
|
</h3><div class="docstring">
|
789
897
|
<div class="discussion">
|
790
|
-
|
898
|
+
<p>
|
899
|
+
First item: parsed data; second item: raw body
|
900
|
+
</p>
|
901
|
+
|
791
902
|
|
792
903
|
</div>
|
793
904
|
</div>
|
@@ -803,12 +914,13 @@ $release. ,</p>
|
|
803
914
|
<span class='type'>(<tt>Hash</tt>)</span>
|
804
915
|
|
805
916
|
|
806
|
-
<em class="default">(defaults to: <tt>{
|
917
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
807
918
|
|
808
919
|
|
809
920
|
—
|
810
|
-
<div class='inline'>
|
811
|
-
|
921
|
+
<div class='inline'><p>
|
922
|
+
a hash of params to be passed to the service
|
923
|
+
</p>
|
812
924
|
</div>
|
813
925
|
|
814
926
|
</li>
|
@@ -821,12 +933,13 @@ $release. ,</p>
|
|
821
933
|
<span class='type'>(<tt>Hash</tt>)</span>
|
822
934
|
|
823
935
|
|
824
|
-
<em class="default">(defaults to: <tt>{
|
936
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
825
937
|
|
826
938
|
|
827
939
|
—
|
828
|
-
<div class='inline'>
|
829
|
-
|
940
|
+
<div class='inline'><p>
|
941
|
+
additional http headers
|
942
|
+
</p>
|
830
943
|
</div>
|
831
944
|
|
832
945
|
</li>
|
@@ -855,22 +968,26 @@ $release. ,</p>
|
|
855
968
|
|
856
969
|
</span>
|
857
970
|
|
858
|
-
— <div class='inline'>
|
859
|
-
|
860
|
-
|
861
|
-
<
|
862
|
-
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
|
870
|
-
|
871
|
-
version
|
872
|
-
$
|
873
|
-
|
971
|
+
— <div class='inline'><p>
|
972
|
+
allowed keys are:
|
973
|
+
</p>
|
974
|
+
<ul>
|
975
|
+
<li>name [String] Name of media
|
976
|
+
|
977
|
+
</li>
|
978
|
+
<li>os_family [String, nil] The family that the operating system belongs to.
|
979
|
+
available families: archlinux debian redhat solaris suse windows
|
980
|
+
|
981
|
+
</li>
|
982
|
+
<li>path [String] The path to the medium, can be a url or a valid nfs server
|
983
|
+
(exclusive of the architecture). for example
|
984
|
+
http://mirror.averse.net/centos/$version/os/$arch where $arch will be
|
985
|
+
substituted for the host&#8217;s actual os architecture and $version,
|
986
|
+
$major and $minor will be substituted for the version of the operating
|
987
|
+
system. solaris and debian media may also use $release.
|
988
|
+
|
989
|
+
</li>
|
990
|
+
</ul>
|
874
991
|
</div>
|
875
992
|
|
876
993
|
</li>
|
@@ -880,6 +997,25 @@ $release. ,</p>
|
|
880
997
|
|
881
998
|
|
882
999
|
|
1000
|
+
<p class="tag_title">Returns:</p>
|
1001
|
+
<ul class="return">
|
1002
|
+
|
1003
|
+
<li>
|
1004
|
+
|
1005
|
+
|
1006
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1007
|
+
|
1008
|
+
|
1009
|
+
|
1010
|
+
—
|
1011
|
+
<div class='inline'><p>
|
1012
|
+
First item: parsed data; second item: raw body
|
1013
|
+
</p>
|
1014
|
+
</div>
|
1015
|
+
|
1016
|
+
</li>
|
1017
|
+
|
1018
|
+
</ul>
|
883
1019
|
|
884
1020
|
</div><table class="source_code">
|
885
1021
|
<tr>
|
@@ -887,20 +1023,17 @@ $release. ,</p>
|
|
887
1023
|
<pre class="lines">
|
888
1024
|
|
889
1025
|
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
57
|
894
|
-
58</pre>
|
1026
|
+
52
|
1027
|
+
53
|
1028
|
+
54</pre>
|
895
1029
|
</td>
|
896
1030
|
<td>
|
897
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line
|
1031
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/medium.rb', line 52</span>
|
898
1032
|
|
899
|
-
<span class='kw'>def</span> <span class='
|
900
|
-
<span class='
|
901
|
-
|
902
|
-
|
903
|
-
<span class='kw'>end</span></pre>
|
1033
|
+
<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>
|
1034
|
+
<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>
|
1035
|
+
<span class='rubyid_end end kw'>end</span>
|
1036
|
+
</pre>
|
904
1037
|
</td>
|
905
1038
|
</tr>
|
906
1039
|
</table>
|
@@ -911,9 +1044,9 @@ $release. ,</p>
|
|
911
1044
|
</div>
|
912
1045
|
|
913
1046
|
<div id="footer">
|
914
|
-
Generated on
|
1047
|
+
Generated on Tue Mar 19 09:50:24 2013 by
|
915
1048
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
916
|
-
0.8.
|
1049
|
+
0.8.5.2 (ruby-1.8.7).
|
917
1050
|
</div>
|
918
1051
|
|
919
1052
|
</body>
|