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::Subnet
|
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/subnet.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'>"subnets"</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,35 +394,50 @@
|
|
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
|
-
|
399
|
-
|
400
|
-
</li
|
401
|
-
<
|
402
|
-
|
403
|
-
|
404
|
-
|
397
|
+
— <div class='inline'><p>
|
398
|
+
allowed keys are:
|
399
|
+
</p>
|
400
|
+
<ul>
|
401
|
+
<li>dhcp_id [String] Dhcp proxy to use within this subnet
|
402
|
+
|
403
|
+
</li>
|
404
|
+
<li>dns_id [String] Dns proxy to use within this subnet
|
405
|
+
|
406
|
+
</li>
|
407
|
+
<li>domain_ids [String] Domains in which this subnet is part
|
408
|
+
|
409
|
+
</li>
|
410
|
+
<li>tftp_id [String] Tftp proxy to use within this subnet
|
411
|
+
|
412
|
+
</li>
|
413
|
+
<li>dns_primary [String] Primary dns for this subnet
|
414
|
+
|
415
|
+
</li>
|
416
|
+
<li>dns_secondary [String] Secondary dns for this subnet
|
417
|
+
|
418
|
+
</li>
|
419
|
+
<li>from [String] Starting ip address for ip auto suggestion
|
420
|
+
|
421
|
+
</li>
|
422
|
+
<li>gateway [String] Primary dns for this subnet
|
423
|
+
|
424
|
+
</li>
|
425
|
+
<li>mask [String] Netmask for this subnet
|
426
|
+
|
427
|
+
</li>
|
428
|
+
<li>name [String] Subnet name
|
429
|
+
|
430
|
+
</li>
|
431
|
+
<li>network [String] Subnet network
|
432
|
+
|
433
|
+
</li>
|
434
|
+
<li>to [String] Ending ip address for ip auto suggestion
|
435
|
+
|
436
|
+
</li>
|
437
|
+
<li>vlanid [String] Vlan id for this subnet
|
438
|
+
|
439
|
+
</li>
|
440
|
+
</ul>
|
405
441
|
</div>
|
406
442
|
|
407
443
|
</li>
|
@@ -411,6 +447,25 @@
|
|
411
447
|
|
412
448
|
|
413
449
|
|
450
|
+
<p class="tag_title">Returns:</p>
|
451
|
+
<ul class="return">
|
452
|
+
|
453
|
+
<li>
|
454
|
+
|
455
|
+
|
456
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
—
|
461
|
+
<div class='inline'><p>
|
462
|
+
First item: parsed data; second item: raw body
|
463
|
+
</p>
|
464
|
+
</div>
|
465
|
+
|
466
|
+
</li>
|
467
|
+
|
468
|
+
</ul>
|
414
469
|
|
415
470
|
</div><table class="source_code">
|
416
471
|
<tr>
|
@@ -418,20 +473,17 @@
|
|
418
473
|
<pre class="lines">
|
419
474
|
|
420
475
|
|
476
|
+
48
|
421
477
|
49
|
422
|
-
50
|
423
|
-
51
|
424
|
-
52
|
425
|
-
53</pre>
|
478
|
+
50</pre>
|
426
479
|
</td>
|
427
480
|
<td>
|
428
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line
|
481
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 48</span>
|
429
482
|
|
430
|
-
<span class='kw'>def</span> <span class='
|
431
|
-
<span class='
|
432
|
-
|
433
|
-
|
434
|
-
<span class='kw'>end</span></pre>
|
483
|
+
<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>
|
484
|
+
<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>
|
485
|
+
<span class='rubyid_end end kw'>end</span>
|
486
|
+
</pre>
|
435
487
|
</td>
|
436
488
|
</tr>
|
437
489
|
</table>
|
@@ -440,7 +492,7 @@
|
|
440
492
|
<div class="method_details ">
|
441
493
|
<h3 class="signature " id="destroy-instance_method">
|
442
494
|
|
443
|
-
- (<tt>
|
495
|
+
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
444
496
|
|
445
497
|
|
446
498
|
|
@@ -448,7 +500,10 @@
|
|
448
500
|
|
449
501
|
</h3><div class="docstring">
|
450
502
|
<div class="discussion">
|
451
|
-
|
503
|
+
<p>
|
504
|
+
First item: parsed data; second item: raw body
|
505
|
+
</p>
|
506
|
+
|
452
507
|
|
453
508
|
</div>
|
454
509
|
</div>
|
@@ -464,12 +519,13 @@
|
|
464
519
|
<span class='type'>(<tt>Hash</tt>)</span>
|
465
520
|
|
466
521
|
|
467
|
-
<em class="default">(defaults to: <tt>{
|
522
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
468
523
|
|
469
524
|
|
470
525
|
—
|
471
|
-
<div class='inline'>
|
472
|
-
|
526
|
+
<div class='inline'><p>
|
527
|
+
a hash of params to be passed to the service
|
528
|
+
</p>
|
473
529
|
</div>
|
474
530
|
|
475
531
|
</li>
|
@@ -482,12 +538,13 @@
|
|
482
538
|
<span class='type'>(<tt>Hash</tt>)</span>
|
483
539
|
|
484
540
|
|
485
|
-
<em class="default">(defaults to: <tt>{
|
541
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
486
542
|
|
487
543
|
|
488
544
|
—
|
489
|
-
<div class='inline'>
|
490
|
-
|
545
|
+
<div class='inline'><p>
|
546
|
+
additional http headers
|
547
|
+
</p>
|
491
548
|
</div>
|
492
549
|
|
493
550
|
</li>
|
@@ -507,8 +564,9 @@
|
|
507
564
|
|
508
565
|
</span>
|
509
566
|
|
510
|
-
— <div class='inline'>
|
511
|
-
|
567
|
+
— <div class='inline'><p>
|
568
|
+
Subnet numeric identifier
|
569
|
+
</p>
|
512
570
|
</div>
|
513
571
|
|
514
572
|
</li>
|
@@ -518,6 +576,25 @@
|
|
518
576
|
|
519
577
|
|
520
578
|
|
579
|
+
<p class="tag_title">Returns:</p>
|
580
|
+
<ul class="return">
|
581
|
+
|
582
|
+
<li>
|
583
|
+
|
584
|
+
|
585
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
—
|
590
|
+
<div class='inline'><p>
|
591
|
+
First item: parsed data; second item: raw body
|
592
|
+
</p>
|
593
|
+
</div>
|
594
|
+
|
595
|
+
</li>
|
596
|
+
|
597
|
+
</ul>
|
521
598
|
|
522
599
|
</div><table class="source_code">
|
523
600
|
<tr>
|
@@ -525,20 +602,17 @@
|
|
525
602
|
<pre class="lines">
|
526
603
|
|
527
604
|
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
87
|
532
|
-
88</pre>
|
605
|
+
81
|
606
|
+
82
|
607
|
+
83</pre>
|
533
608
|
</td>
|
534
609
|
<td>
|
535
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line
|
610
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 81</span>
|
536
611
|
|
537
|
-
<span class='kw'>def</span> <span class='
|
538
|
-
<span class='
|
539
|
-
|
540
|
-
|
541
|
-
<span class='kw'>end</span></pre>
|
612
|
+
<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>
|
613
|
+
<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>
|
614
|
+
<span class='rubyid_end end kw'>end</span>
|
615
|
+
</pre>
|
542
616
|
</td>
|
543
617
|
</tr>
|
544
618
|
</table>
|
@@ -547,7 +621,7 @@
|
|
547
621
|
<div class="method_details ">
|
548
622
|
<h3 class="signature " id="index-instance_method">
|
549
623
|
|
550
|
-
- (<tt>
|
624
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
551
625
|
|
552
626
|
|
553
627
|
|
@@ -555,7 +629,10 @@
|
|
555
629
|
|
556
630
|
</h3><div class="docstring">
|
557
631
|
<div class="discussion">
|
558
|
-
|
632
|
+
<p>
|
633
|
+
First item: parsed data; second item: raw body
|
634
|
+
</p>
|
635
|
+
|
559
636
|
|
560
637
|
</div>
|
561
638
|
</div>
|
@@ -571,12 +648,13 @@
|
|
571
648
|
<span class='type'>(<tt>Hash</tt>)</span>
|
572
649
|
|
573
650
|
|
574
|
-
<em class="default">(defaults to: <tt>{
|
651
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
575
652
|
|
576
653
|
|
577
654
|
—
|
578
|
-
<div class='inline'>
|
579
|
-
|
655
|
+
<div class='inline'><p>
|
656
|
+
a hash of params to be passed to the service
|
657
|
+
</p>
|
580
658
|
</div>
|
581
659
|
|
582
660
|
</li>
|
@@ -589,12 +667,13 @@
|
|
589
667
|
<span class='type'>(<tt>Hash</tt>)</span>
|
590
668
|
|
591
669
|
|
592
|
-
<em class="default">(defaults to: <tt>{
|
670
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
593
671
|
|
594
672
|
|
595
673
|
—
|
596
|
-
<div class='inline'>
|
597
|
-
|
674
|
+
<div class='inline'><p>
|
675
|
+
additional http headers
|
676
|
+
</p>
|
598
677
|
</div>
|
599
678
|
|
600
679
|
</li>
|
@@ -614,8 +693,9 @@
|
|
614
693
|
|
615
694
|
</span>
|
616
695
|
|
617
|
-
— <div class='inline'>
|
618
|
-
|
696
|
+
— <div class='inline'><p>
|
697
|
+
Sort results
|
698
|
+
</p>
|
619
699
|
</div>
|
620
700
|
|
621
701
|
</li>
|
@@ -627,8 +707,9 @@
|
|
627
707
|
|
628
708
|
</span>
|
629
709
|
|
630
|
-
— <div class='inline'>
|
631
|
-
|
710
|
+
— <div class='inline'><p>
|
711
|
+
Paginate results
|
712
|
+
</p>
|
632
713
|
</div>
|
633
714
|
|
634
715
|
</li>
|
@@ -640,8 +721,9 @@
|
|
640
721
|
|
641
722
|
</span>
|
642
723
|
|
643
|
-
— <div class='inline'>
|
644
|
-
|
724
|
+
— <div class='inline'><p>
|
725
|
+
Number of entries per request
|
726
|
+
</p>
|
645
727
|
</div>
|
646
728
|
|
647
729
|
</li>
|
@@ -653,8 +735,9 @@
|
|
653
735
|
|
654
736
|
</span>
|
655
737
|
|
656
|
-
— <div class='inline'>
|
657
|
-
|
738
|
+
— <div class='inline'><p>
|
739
|
+
Filter results
|
740
|
+
</p>
|
658
741
|
</div>
|
659
742
|
|
660
743
|
</li>
|
@@ -664,6 +747,25 @@
|
|
664
747
|
|
665
748
|
|
666
749
|
|
750
|
+
<p class="tag_title">Returns:</p>
|
751
|
+
<ul class="return">
|
752
|
+
|
753
|
+
<li>
|
754
|
+
|
755
|
+
|
756
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
—
|
761
|
+
<div class='inline'><p>
|
762
|
+
First item: parsed data; second item: raw body
|
763
|
+
</p>
|
764
|
+
</div>
|
765
|
+
|
766
|
+
</li>
|
767
|
+
|
768
|
+
</ul>
|
667
769
|
|
668
770
|
</div><table class="source_code">
|
669
771
|
<tr>
|
@@ -671,20 +773,17 @@
|
|
671
773
|
<pre class="lines">
|
672
774
|
|
673
775
|
|
674
|
-
15
|
675
776
|
16
|
676
777
|
17
|
677
|
-
18
|
678
|
-
19</pre>
|
778
|
+
18</pre>
|
679
779
|
</td>
|
680
780
|
<td>
|
681
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line
|
781
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 16</span>
|
682
782
|
|
683
|
-
<span class='kw'>def</span> <span class='
|
684
|
-
<span class='
|
685
|
-
|
686
|
-
|
687
|
-
<span class='kw'>end</span></pre>
|
783
|
+
<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>
|
784
|
+
<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>
|
785
|
+
<span class='rubyid_end end kw'>end</span>
|
786
|
+
</pre>
|
688
787
|
</td>
|
689
788
|
</tr>
|
690
789
|
</table>
|
@@ -693,7 +792,7 @@
|
|
693
792
|
<div class="method_details ">
|
694
793
|
<h3 class="signature " id="show-instance_method">
|
695
794
|
|
696
|
-
- (<tt>
|
795
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
697
796
|
|
698
797
|
|
699
798
|
|
@@ -701,7 +800,10 @@
|
|
701
800
|
|
702
801
|
</h3><div class="docstring">
|
703
802
|
<div class="discussion">
|
704
|
-
|
803
|
+
<p>
|
804
|
+
First item: parsed data; second item: raw body
|
805
|
+
</p>
|
806
|
+
|
705
807
|
|
706
808
|
</div>
|
707
809
|
</div>
|
@@ -717,12 +819,13 @@
|
|
717
819
|
<span class='type'>(<tt>Hash</tt>)</span>
|
718
820
|
|
719
821
|
|
720
|
-
<em class="default">(defaults to: <tt>{
|
822
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
721
823
|
|
722
824
|
|
723
825
|
—
|
724
|
-
<div class='inline'>
|
725
|
-
|
826
|
+
<div class='inline'><p>
|
827
|
+
a hash of params to be passed to the service
|
828
|
+
</p>
|
726
829
|
</div>
|
727
830
|
|
728
831
|
</li>
|
@@ -735,12 +838,13 @@
|
|
735
838
|
<span class='type'>(<tt>Hash</tt>)</span>
|
736
839
|
|
737
840
|
|
738
|
-
<em class="default">(defaults to: <tt>{
|
841
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
739
842
|
|
740
843
|
|
741
844
|
—
|
742
|
-
<div class='inline'>
|
743
|
-
|
845
|
+
<div class='inline'><p>
|
846
|
+
additional http headers
|
847
|
+
</p>
|
744
848
|
</div>
|
745
849
|
|
746
850
|
</li>
|
@@ -767,6 +871,25 @@
|
|
767
871
|
|
768
872
|
|
769
873
|
|
874
|
+
<p class="tag_title">Returns:</p>
|
875
|
+
<ul class="return">
|
876
|
+
|
877
|
+
<li>
|
878
|
+
|
879
|
+
|
880
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
—
|
885
|
+
<div class='inline'><p>
|
886
|
+
First item: parsed data; second item: raw body
|
887
|
+
</p>
|
888
|
+
</div>
|
889
|
+
|
890
|
+
</li>
|
891
|
+
|
892
|
+
</ul>
|
770
893
|
|
771
894
|
</div><table class="source_code">
|
772
895
|
<tr>
|
@@ -776,18 +899,15 @@
|
|
776
899
|
|
777
900
|
25
|
778
901
|
26
|
779
|
-
27
|
780
|
-
28
|
781
|
-
29</pre>
|
902
|
+
27</pre>
|
782
903
|
</td>
|
783
904
|
<td>
|
784
905
|
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 25</span>
|
785
906
|
|
786
|
-
<span class='kw'>def</span> <span class='
|
787
|
-
<span class='
|
788
|
-
|
789
|
-
|
790
|
-
<span class='kw'>end</span></pre>
|
907
|
+
<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>
|
908
|
+
<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>
|
909
|
+
<span class='rubyid_end end kw'>end</span>
|
910
|
+
</pre>
|
791
911
|
</td>
|
792
912
|
</tr>
|
793
913
|
</table>
|
@@ -796,7 +916,7 @@
|
|
796
916
|
<div class="method_details ">
|
797
917
|
<h3 class="signature " id="update-instance_method">
|
798
918
|
|
799
|
-
- (<tt>
|
919
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
800
920
|
|
801
921
|
|
802
922
|
|
@@ -804,7 +924,10 @@
|
|
804
924
|
|
805
925
|
</h3><div class="docstring">
|
806
926
|
<div class="discussion">
|
807
|
-
|
927
|
+
<p>
|
928
|
+
First item: parsed data; second item: raw body
|
929
|
+
</p>
|
930
|
+
|
808
931
|
|
809
932
|
</div>
|
810
933
|
</div>
|
@@ -820,12 +943,13 @@
|
|
820
943
|
<span class='type'>(<tt>Hash</tt>)</span>
|
821
944
|
|
822
945
|
|
823
|
-
<em class="default">(defaults to: <tt>{
|
946
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
824
947
|
|
825
948
|
|
826
949
|
—
|
827
|
-
<div class='inline'>
|
828
|
-
|
950
|
+
<div class='inline'><p>
|
951
|
+
a hash of params to be passed to the service
|
952
|
+
</p>
|
829
953
|
</div>
|
830
954
|
|
831
955
|
</li>
|
@@ -838,12 +962,13 @@
|
|
838
962
|
<span class='type'>(<tt>Hash</tt>)</span>
|
839
963
|
|
840
964
|
|
841
|
-
<em class="default">(defaults to: <tt>{
|
965
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
842
966
|
|
843
967
|
|
844
968
|
—
|
845
|
-
<div class='inline'>
|
846
|
-
|
969
|
+
<div class='inline'><p>
|
970
|
+
additional http headers
|
971
|
+
</p>
|
847
972
|
</div>
|
848
973
|
|
849
974
|
</li>
|
@@ -863,8 +988,9 @@
|
|
863
988
|
|
864
989
|
</span>
|
865
990
|
|
866
|
-
— <div class='inline'>
|
867
|
-
|
991
|
+
— <div class='inline'><p>
|
992
|
+
Subnet numeric identifier
|
993
|
+
</p>
|
868
994
|
</div>
|
869
995
|
|
870
996
|
</li>
|
@@ -876,35 +1002,50 @@
|
|
876
1002
|
|
877
1003
|
</span>
|
878
1004
|
|
879
|
-
— <div class='inline'>
|
880
|
-
|
881
|
-
|
882
|
-
<
|
883
|
-
|
884
|
-
|
885
|
-
</li
|
886
|
-
<
|
887
|
-
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
</li
|
892
|
-
<
|
893
|
-
|
894
|
-
|
895
|
-
|
896
|
-
|
897
|
-
</li
|
898
|
-
<
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
|
903
|
-
</li
|
904
|
-
<
|
905
|
-
|
906
|
-
|
907
|
-
|
1005
|
+
— <div class='inline'><p>
|
1006
|
+
allowed keys are:
|
1007
|
+
</p>
|
1008
|
+
<ul>
|
1009
|
+
<li>dhcp_id [String, nil] Dhcp proxy to use within this subnet
|
1010
|
+
|
1011
|
+
</li>
|
1012
|
+
<li>dns_id [String, nil] Dns proxy to use within this subnet
|
1013
|
+
|
1014
|
+
</li>
|
1015
|
+
<li>domain_ids [String, nil] Domains in which this subnet is part
|
1016
|
+
|
1017
|
+
</li>
|
1018
|
+
<li>tftp_id [String, nil] Tftp proxy to use within this subnet
|
1019
|
+
|
1020
|
+
</li>
|
1021
|
+
<li>dns_primary [String, nil] Primary dns for this subnet
|
1022
|
+
|
1023
|
+
</li>
|
1024
|
+
<li>dns_secondary [String, nil] Secondary dns for this subnet
|
1025
|
+
|
1026
|
+
</li>
|
1027
|
+
<li>from [String, nil] Starting ip address for ip auto suggestion
|
1028
|
+
|
1029
|
+
</li>
|
1030
|
+
<li>gateway [String, nil] Primary dns for this subnet
|
1031
|
+
|
1032
|
+
</li>
|
1033
|
+
<li>mask [String] Netmask for this subnet
|
1034
|
+
|
1035
|
+
</li>
|
1036
|
+
<li>name [String] Subnet name
|
1037
|
+
|
1038
|
+
</li>
|
1039
|
+
<li>network [String] Subnet network
|
1040
|
+
|
1041
|
+
</li>
|
1042
|
+
<li>to [String, nil] Ending ip address for ip auto suggestion
|
1043
|
+
|
1044
|
+
</li>
|
1045
|
+
<li>vlanid [String, nil] Vlan id for this subnet
|
1046
|
+
|
1047
|
+
</li>
|
1048
|
+
</ul>
|
908
1049
|
</div>
|
909
1050
|
|
910
1051
|
</li>
|
@@ -914,6 +1055,25 @@
|
|
914
1055
|
|
915
1056
|
|
916
1057
|
|
1058
|
+
<p class="tag_title">Returns:</p>
|
1059
|
+
<ul class="return">
|
1060
|
+
|
1061
|
+
<li>
|
1062
|
+
|
1063
|
+
|
1064
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
1065
|
+
|
1066
|
+
|
1067
|
+
|
1068
|
+
—
|
1069
|
+
<div class='inline'><p>
|
1070
|
+
First item: parsed data; second item: raw body
|
1071
|
+
</p>
|
1072
|
+
</div>
|
1073
|
+
|
1074
|
+
</li>
|
1075
|
+
|
1076
|
+
</ul>
|
917
1077
|
|
918
1078
|
</div><table class="source_code">
|
919
1079
|
<tr>
|
@@ -921,20 +1081,17 @@
|
|
921
1081
|
<pre class="lines">
|
922
1082
|
|
923
1083
|
|
924
|
-
|
925
|
-
|
926
|
-
|
927
|
-
77
|
928
|
-
78</pre>
|
1084
|
+
72
|
1085
|
+
73
|
1086
|
+
74</pre>
|
929
1087
|
</td>
|
930
1088
|
<td>
|
931
|
-
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line
|
1089
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 72</span>
|
932
1090
|
|
933
|
-
<span class='kw'>def</span> <span class='
|
934
|
-
<span class='
|
935
|
-
|
936
|
-
|
937
|
-
<span class='kw'>end</span></pre>
|
1091
|
+
<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>
|
1092
|
+
<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>
|
1093
|
+
<span class='rubyid_end end kw'>end</span>
|
1094
|
+
</pre>
|
938
1095
|
</td>
|
939
1096
|
</tr>
|
940
1097
|
</table>
|
@@ -945,9 +1102,9 @@
|
|
945
1102
|
</div>
|
946
1103
|
|
947
1104
|
<div id="footer">
|
948
|
-
Generated on
|
1105
|
+
Generated on Tue Mar 19 09:50:24 2013 by
|
949
1106
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
950
|
-
0.8.
|
1107
|
+
0.8.5.2 (ruby-1.8.7).
|
951
1108
|
</div>
|
952
1109
|
|
953
1110
|
</body>
|