foreman_api 0.1.6 → 0.1.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/doc/ForemanApi.html +3 -3
- data/doc/ForemanApi/Resources.html +4 -4
- data/doc/ForemanApi/Resources/Architecture.html +7 -7
- data/doc/ForemanApi/Resources/Audit.html +5 -5
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +15 -15
- data/doc/ForemanApi/Resources/Bookmark.html +3 -3
- data/doc/ForemanApi/Resources/CommonParameter.html +5 -5
- data/doc/ForemanApi/Resources/ComputeResource.html +167 -24
- data/doc/ForemanApi/Resources/ConfigTemplate.html +14 -14
- data/doc/ForemanApi/Resources/Dashboard.html +2 -2
- data/doc/ForemanApi/Resources/Domain.html +14 -14
- data/doc/ForemanApi/Resources/Environment.html +199 -25
- data/doc/ForemanApi/Resources/FactValue.html +5 -5
- data/doc/ForemanApi/Resources/Home.html +1 -1
- data/doc/ForemanApi/Resources/Host.html +509 -10
- data/doc/ForemanApi/Resources/HostClass.html +5 -5
- data/doc/ForemanApi/Resources/Hostgroup.html +5 -5
- data/doc/ForemanApi/Resources/HostgroupClass.html +5 -5
- data/doc/ForemanApi/Resources/Image.html +5 -5
- data/doc/ForemanApi/Resources/Interface.html +1045 -0
- data/doc/ForemanApi/Resources/Location.html +5 -5
- data/doc/ForemanApi/Resources/LookupKey.html +62 -811
- data/doc/ForemanApi/Resources/Medium.html +13 -13
- data/doc/ForemanApi/Resources/Model.html +5 -5
- data/doc/ForemanApi/Resources/OperatingSystem.html +5 -5
- data/doc/ForemanApi/Resources/Organization.html +5 -5
- data/doc/ForemanApi/Resources/OverrideValue.html +1060 -0
- data/doc/ForemanApi/Resources/Parameter.html +26 -26
- data/doc/ForemanApi/Resources/Ptable.html +5 -5
- data/doc/ForemanApi/Resources/Puppetclass.html +80 -28
- data/doc/ForemanApi/Resources/Report.html +164 -6
- data/doc/ForemanApi/Resources/Role.html +3 -3
- data/doc/ForemanApi/Resources/Setting.html +5 -5
- data/doc/ForemanApi/Resources/SmartClassParameter.html +747 -0
- data/doc/ForemanApi/Resources/SmartProxy.html +341 -24
- data/doc/ForemanApi/Resources/SmartVariable.html +1043 -0
- data/doc/ForemanApi/Resources/Statistic.html +330 -0
- data/doc/ForemanApi/Resources/Subnet.html +33 -33
- data/doc/ForemanApi/Resources/TemplateCombination.html +3 -3
- data/doc/ForemanApi/Resources/TemplateKind.html +3 -3
- data/doc/ForemanApi/Resources/User.html +7 -7
- data/doc/ForemanApi/Resources/Usergroup.html +5 -5
- data/doc/_index.html +36 -1
- data/doc/class_list.html +1 -1
- data/doc/file.MIT-LICENSE.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +515 -347
- data/doc/top-level-namespace.html +1 -1
- data/lib/foreman_api/base.rb +2 -1
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/architecture.rb +6 -6
- data/lib/foreman_api/resources/audit.rb +4 -4
- data/lib/foreman_api/resources/auth_source_ldap.rb +14 -14
- data/lib/foreman_api/resources/bookmark.rb +2 -2
- data/lib/foreman_api/resources/common_parameter.rb +4 -4
- data/lib/foreman_api/resources/compute_resource.rb +29 -20
- data/lib/foreman_api/resources/config_template.rb +13 -13
- data/lib/foreman_api/resources/dashboard.rb +1 -1
- data/lib/foreman_api/resources/domain.rb +13 -13
- data/lib/foreman_api/resources/environment.rb +16 -4
- data/lib/foreman_api/resources/fact_value.rb +4 -4
- data/lib/foreman_api/resources/host.rb +40 -8
- data/lib/foreman_api/resources/host_class.rb +4 -4
- data/lib/foreman_api/resources/hostgroup.rb +4 -4
- data/lib/foreman_api/resources/hostgroup_class.rb +4 -4
- data/lib/foreman_api/resources/image.rb +4 -4
- data/lib/foreman_api/resources/interface.rb +80 -0
- data/lib/foreman_api/resources/location.rb +4 -4
- data/lib/foreman_api/resources/lookup_key.rb +6 -65
- data/lib/foreman_api/resources/medium.rb +10 -10
- data/lib/foreman_api/resources/model.rb +4 -4
- data/lib/foreman_api/resources/operating_system.rb +4 -4
- data/lib/foreman_api/resources/organization.rb +4 -4
- data/lib/foreman_api/resources/override_value.rb +73 -0
- data/lib/foreman_api/resources/parameter.rb +25 -25
- data/lib/foreman_api/resources/ptable.rb +4 -4
- data/lib/foreman_api/resources/puppetclass.rb +11 -7
- data/lib/foreman_api/resources/report.rb +19 -4
- data/lib/foreman_api/resources/role.rb +2 -2
- data/lib/foreman_api/resources/setting.rb +4 -4
- data/lib/foreman_api/resources/smart_class_parameter.rb +55 -0
- data/lib/foreman_api/resources/smart_proxy.rb +24 -3
- data/lib/foreman_api/resources/smart_variable.rb +80 -0
- data/lib/foreman_api/resources/statistic.rb +18 -0
- data/lib/foreman_api/resources/subnet.rb +32 -32
- data/lib/foreman_api/resources/template_combination.rb +2 -2
- data/lib/foreman_api/resources/template_kind.rb +2 -2
- data/lib/foreman_api/resources/user.rb +6 -6
- data/lib/foreman_api/resources/usergroup.rb +4 -4
- data/lib/foreman_api/version.rb +1 -1
- metadata +13 -3
@@ -150,6 +150,30 @@
|
|
150
150
|
<li class="public ">
|
151
151
|
<span class="summary_signature">
|
152
152
|
|
153
|
+
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
</span>
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
168
|
+
<p>First item: parsed data; second item: raw body.</p>
|
169
|
+
</div></span>
|
170
|
+
|
171
|
+
</li>
|
172
|
+
|
173
|
+
|
174
|
+
<li class="public ">
|
175
|
+
<span class="summary_signature">
|
176
|
+
|
153
177
|
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
|
154
178
|
|
155
179
|
|
@@ -290,7 +314,141 @@
|
|
290
314
|
|
291
315
|
|
292
316
|
<div class="method_details first">
|
293
|
-
<h3 class="signature first" id="
|
317
|
+
<h3 class="signature first" id="create-instance_method">
|
318
|
+
|
319
|
+
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
</h3><div class="docstring">
|
326
|
+
<div class="discussion">
|
327
|
+
|
328
|
+
<p>Returns First item: parsed data; second item: raw body</p>
|
329
|
+
|
330
|
+
|
331
|
+
</div>
|
332
|
+
</div>
|
333
|
+
<div class="tags">
|
334
|
+
<p class="tag_title">Parameters:</p>
|
335
|
+
<ul class="param">
|
336
|
+
|
337
|
+
<li>
|
338
|
+
|
339
|
+
<span class='name'>params</span>
|
340
|
+
|
341
|
+
|
342
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
343
|
+
|
344
|
+
|
345
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
346
|
+
|
347
|
+
|
348
|
+
—
|
349
|
+
<div class='inline'>
|
350
|
+
<p>a hash of params to be passed to the service</p>
|
351
|
+
</div>
|
352
|
+
|
353
|
+
</li>
|
354
|
+
|
355
|
+
<li>
|
356
|
+
|
357
|
+
<span class='name'>headers</span>
|
358
|
+
|
359
|
+
|
360
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
361
|
+
|
362
|
+
|
363
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
364
|
+
|
365
|
+
|
366
|
+
—
|
367
|
+
<div class='inline'>
|
368
|
+
<p>additional http headers</p>
|
369
|
+
</div>
|
370
|
+
|
371
|
+
</li>
|
372
|
+
|
373
|
+
</ul>
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
379
|
+
<ul class="option">
|
380
|
+
|
381
|
+
<li>
|
382
|
+
<span class="name">report</span>
|
383
|
+
<span class="type">(<tt>Hash</tt>)</span>
|
384
|
+
<span class="default">
|
385
|
+
|
386
|
+
</span>
|
387
|
+
|
388
|
+
— <div class='inline'>
|
389
|
+
<p>allowed keys are:</p>
|
390
|
+
<ul><li>
|
391
|
+
<p>host [String] hostname or certname</p>
|
392
|
+
</li><li>
|
393
|
+
<p>logs [Array] optional array of log hashes</p>
|
394
|
+
</li><li>
|
395
|
+
<p>metrics [Hash] hash of report metrics, can be just {}</p>
|
396
|
+
</li><li>
|
397
|
+
<p>reported_at [String] utc time of report</p>
|
398
|
+
</li><li>
|
399
|
+
<p>status [Hash] hash of status type totals</p>
|
400
|
+
</li></ul>
|
401
|
+
</div>
|
402
|
+
|
403
|
+
</li>
|
404
|
+
|
405
|
+
</ul>
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
<p class="tag_title">Returns:</p>
|
411
|
+
<ul class="return">
|
412
|
+
|
413
|
+
<li>
|
414
|
+
|
415
|
+
|
416
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
—
|
421
|
+
<div class='inline'>
|
422
|
+
<p>First item: parsed data; second item: raw body</p>
|
423
|
+
</div>
|
424
|
+
|
425
|
+
</li>
|
426
|
+
|
427
|
+
</ul>
|
428
|
+
|
429
|
+
</div><table class="source_code">
|
430
|
+
<tr>
|
431
|
+
<td>
|
432
|
+
<pre class="lines">
|
433
|
+
|
434
|
+
|
435
|
+
59
|
436
|
+
60
|
437
|
+
61</pre>
|
438
|
+
</td>
|
439
|
+
<td>
|
440
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/report.rb', line 59</span>
|
441
|
+
|
442
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
443
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
444
|
+
<span class='kw'>end</span></pre>
|
445
|
+
</td>
|
446
|
+
</tr>
|
447
|
+
</table>
|
448
|
+
</div>
|
449
|
+
|
450
|
+
<div class="method_details ">
|
451
|
+
<h3 class="signature " id="destroy-instance_method">
|
294
452
|
|
295
453
|
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
|
296
454
|
|
@@ -481,7 +639,7 @@
|
|
481
639
|
</span>
|
482
640
|
|
483
641
|
— <div class='inline'>
|
484
|
-
<p>
|
642
|
+
<p>sort results</p>
|
485
643
|
</div>
|
486
644
|
|
487
645
|
</li>
|
@@ -494,7 +652,7 @@
|
|
494
652
|
</span>
|
495
653
|
|
496
654
|
— <div class='inline'>
|
497
|
-
<p>
|
655
|
+
<p>paginate results</p>
|
498
656
|
</div>
|
499
657
|
|
500
658
|
</li>
|
@@ -507,7 +665,7 @@
|
|
507
665
|
</span>
|
508
666
|
|
509
667
|
— <div class='inline'>
|
510
|
-
<p>
|
668
|
+
<p>number of entries per request</p>
|
511
669
|
</div>
|
512
670
|
|
513
671
|
</li>
|
@@ -520,7 +678,7 @@
|
|
520
678
|
</span>
|
521
679
|
|
522
680
|
— <div class='inline'>
|
523
|
-
<p>
|
681
|
+
<p>filter results</p>
|
524
682
|
</div>
|
525
683
|
|
526
684
|
</li>
|
@@ -826,7 +984,7 @@
|
|
826
984
|
</div>
|
827
985
|
|
828
986
|
<div id="footer">
|
829
|
-
Generated on Mon
|
987
|
+
Generated on Mon Oct 21 11:10:44 2013 by
|
830
988
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
831
989
|
0.8.7 (ruby-2.0.0).
|
832
990
|
</div>
|
@@ -631,7 +631,7 @@
|
|
631
631
|
</span>
|
632
632
|
|
633
633
|
— <div class='inline'>
|
634
|
-
<p>
|
634
|
+
<p>paginate results</p>
|
635
635
|
</div>
|
636
636
|
|
637
637
|
</li>
|
@@ -644,7 +644,7 @@
|
|
644
644
|
</span>
|
645
645
|
|
646
646
|
— <div class='inline'>
|
647
|
-
<p>
|
647
|
+
<p>number of entries per request</p>
|
648
648
|
</div>
|
649
649
|
|
650
650
|
</li>
|
@@ -953,7 +953,7 @@
|
|
953
953
|
</div>
|
954
954
|
|
955
955
|
<div id="footer">
|
956
|
-
Generated on Mon
|
956
|
+
Generated on Mon Oct 21 11:10:43 2013 by
|
957
957
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
958
958
|
0.8.7 (ruby-2.0.0).
|
959
959
|
</div>
|
@@ -338,7 +338,7 @@
|
|
338
338
|
</span>
|
339
339
|
|
340
340
|
— <div class='inline'>
|
341
|
-
<p>
|
341
|
+
<p>sort results</p>
|
342
342
|
</div>
|
343
343
|
|
344
344
|
</li>
|
@@ -351,7 +351,7 @@
|
|
351
351
|
</span>
|
352
352
|
|
353
353
|
— <div class='inline'>
|
354
|
-
<p>
|
354
|
+
<p>paginate results</p>
|
355
355
|
</div>
|
356
356
|
|
357
357
|
</li>
|
@@ -364,7 +364,7 @@
|
|
364
364
|
</span>
|
365
365
|
|
366
366
|
— <div class='inline'>
|
367
|
-
<p>
|
367
|
+
<p>number of entries per request</p>
|
368
368
|
</div>
|
369
369
|
|
370
370
|
</li>
|
@@ -377,7 +377,7 @@
|
|
377
377
|
</span>
|
378
378
|
|
379
379
|
— <div class='inline'>
|
380
|
-
<p>
|
380
|
+
<p>filter results</p>
|
381
381
|
</div>
|
382
382
|
|
383
383
|
</li>
|
@@ -686,7 +686,7 @@
|
|
686
686
|
</div>
|
687
687
|
|
688
688
|
<div id="footer">
|
689
|
-
Generated on Mon
|
689
|
+
Generated on Mon Oct 21 11:10:44 2013 by
|
690
690
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
691
691
|
0.8.7 (ruby-2.0.0).
|
692
692
|
</div>
|
@@ -0,0 +1,747 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: ForemanApi::Resources::SmartClassParameter
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../../';
|
20
|
+
framesUrl = "../../frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../../_index.html">Index (S)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">SmartClassParameter</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Class: ForemanApi::Resources::SmartClassParameter
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Base</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">Base</li>
|
82
|
+
|
83
|
+
<li class="next">ForemanApi::Resources::SmartClassParameter</li>
|
84
|
+
|
85
|
+
</ul>
|
86
|
+
<a href="#" class="inheritanceTree">show all</a>
|
87
|
+
|
88
|
+
</dd>
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
<dt class="r2 last">Defined in:</dt>
|
99
|
+
<dd class="r2 last">lib/foreman_api/resources/smart_class_parameter.rb</dd>
|
100
|
+
|
101
|
+
</dl>
|
102
|
+
<div class="clear"></div>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
<h2>
|
113
|
+
Class Method Summary
|
114
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
115
|
+
</h2>
|
116
|
+
|
117
|
+
<ul class="summary">
|
118
|
+
|
119
|
+
<li class="public ">
|
120
|
+
<span class="summary_signature">
|
121
|
+
|
122
|
+
<a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
</span>
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
</ul>
|
142
|
+
|
143
|
+
<h2>
|
144
|
+
Instance Method Summary
|
145
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
146
|
+
</h2>
|
147
|
+
|
148
|
+
<ul class="summary">
|
149
|
+
|
150
|
+
<li class="public ">
|
151
|
+
<span class="summary_signature">
|
152
|
+
|
153
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
</span>
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
168
|
+
<p>First item: parsed data; second item: raw body.</p>
|
169
|
+
</div></span>
|
170
|
+
|
171
|
+
</li>
|
172
|
+
|
173
|
+
|
174
|
+
<li class="public ">
|
175
|
+
<span class="summary_signature">
|
176
|
+
|
177
|
+
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
</span>
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
<span class="summary_desc"><div class='inline'>
|
192
|
+
<p>First item: parsed data; second item: raw body.</p>
|
193
|
+
</div></span>
|
194
|
+
|
195
|
+
</li>
|
196
|
+
|
197
|
+
|
198
|
+
<li class="public ">
|
199
|
+
<span class="summary_signature">
|
200
|
+
|
201
|
+
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
</span>
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
<span class="summary_desc"><div class='inline'>
|
216
|
+
<p>First item: parsed data; second item: raw body.</p>
|
217
|
+
</div></span>
|
218
|
+
|
219
|
+
</li>
|
220
|
+
|
221
|
+
|
222
|
+
</ul>
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<div id="class_method_details" class="method_details_list">
|
229
|
+
<h2>Class Method Details</h2>
|
230
|
+
|
231
|
+
|
232
|
+
<div class="method_details first">
|
233
|
+
<h3 class="signature first" id="doc-class_method">
|
234
|
+
|
235
|
+
+ (<tt>Object</tt>) <strong>doc</strong>
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
</h3><table class="source_code">
|
242
|
+
<tr>
|
243
|
+
<td>
|
244
|
+
<pre class="lines">
|
245
|
+
|
246
|
+
|
247
|
+
4
|
248
|
+
5
|
249
|
+
6</pre>
|
250
|
+
</td>
|
251
|
+
<td>
|
252
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/smart_class_parameter.rb', line 4</span>
|
253
|
+
|
254
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
|
255
|
+
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>smart_class_parameters</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
256
|
+
<span class='kw'>end</span></pre>
|
257
|
+
</td>
|
258
|
+
</tr>
|
259
|
+
</table>
|
260
|
+
</div>
|
261
|
+
|
262
|
+
</div>
|
263
|
+
|
264
|
+
<div id="instance_method_details" class="method_details_list">
|
265
|
+
<h2>Instance Method Details</h2>
|
266
|
+
|
267
|
+
|
268
|
+
<div class="method_details first">
|
269
|
+
<h3 class="signature first" id="index-instance_method">
|
270
|
+
|
271
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
</h3><div class="docstring">
|
278
|
+
<div class="discussion">
|
279
|
+
|
280
|
+
<p>Returns First item: parsed data; second item: raw body</p>
|
281
|
+
|
282
|
+
|
283
|
+
</div>
|
284
|
+
</div>
|
285
|
+
<div class="tags">
|
286
|
+
<p class="tag_title">Parameters:</p>
|
287
|
+
<ul class="param">
|
288
|
+
|
289
|
+
<li>
|
290
|
+
|
291
|
+
<span class='name'>params</span>
|
292
|
+
|
293
|
+
|
294
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
295
|
+
|
296
|
+
|
297
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
298
|
+
|
299
|
+
|
300
|
+
—
|
301
|
+
<div class='inline'>
|
302
|
+
<p>a hash of params to be passed to the service</p>
|
303
|
+
</div>
|
304
|
+
|
305
|
+
</li>
|
306
|
+
|
307
|
+
<li>
|
308
|
+
|
309
|
+
<span class='name'>headers</span>
|
310
|
+
|
311
|
+
|
312
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
313
|
+
|
314
|
+
|
315
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
316
|
+
|
317
|
+
|
318
|
+
—
|
319
|
+
<div class='inline'>
|
320
|
+
<p>additional http headers</p>
|
321
|
+
</div>
|
322
|
+
|
323
|
+
</li>
|
324
|
+
|
325
|
+
</ul>
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
331
|
+
<ul class="option">
|
332
|
+
|
333
|
+
<li>
|
334
|
+
<span class="name">environment_id</span>
|
335
|
+
<span class="type">(<tt>String</tt>)</span>
|
336
|
+
<span class="default">
|
337
|
+
|
338
|
+
</span>
|
339
|
+
|
340
|
+
</li>
|
341
|
+
|
342
|
+
<li>
|
343
|
+
<span class="name">host_id</span>
|
344
|
+
<span class="type">(<tt>String</tt>)</span>
|
345
|
+
<span class="default">
|
346
|
+
|
347
|
+
</span>
|
348
|
+
|
349
|
+
</li>
|
350
|
+
|
351
|
+
<li>
|
352
|
+
<span class="name">hostgroup_id</span>
|
353
|
+
<span class="type">(<tt>String</tt>)</span>
|
354
|
+
<span class="default">
|
355
|
+
|
356
|
+
</span>
|
357
|
+
|
358
|
+
</li>
|
359
|
+
|
360
|
+
<li>
|
361
|
+
<span class="name">puppetclass_id</span>
|
362
|
+
<span class="type">(<tt>String</tt>)</span>
|
363
|
+
<span class="default">
|
364
|
+
|
365
|
+
</span>
|
366
|
+
|
367
|
+
</li>
|
368
|
+
|
369
|
+
<li>
|
370
|
+
<span class="name">order</span>
|
371
|
+
<span class="type">(<tt>String</tt>)</span>
|
372
|
+
<span class="default">
|
373
|
+
|
374
|
+
</span>
|
375
|
+
|
376
|
+
— <div class='inline'>
|
377
|
+
<p>sort results</p>
|
378
|
+
</div>
|
379
|
+
|
380
|
+
</li>
|
381
|
+
|
382
|
+
<li>
|
383
|
+
<span class="name">page</span>
|
384
|
+
<span class="type">(<tt>String</tt>)</span>
|
385
|
+
<span class="default">
|
386
|
+
|
387
|
+
</span>
|
388
|
+
|
389
|
+
— <div class='inline'>
|
390
|
+
<p>paginate results</p>
|
391
|
+
</div>
|
392
|
+
|
393
|
+
</li>
|
394
|
+
|
395
|
+
<li>
|
396
|
+
<span class="name">per_page</span>
|
397
|
+
<span class="type">(<tt>String</tt>)</span>
|
398
|
+
<span class="default">
|
399
|
+
|
400
|
+
</span>
|
401
|
+
|
402
|
+
— <div class='inline'>
|
403
|
+
<p>number of entries per request</p>
|
404
|
+
</div>
|
405
|
+
|
406
|
+
</li>
|
407
|
+
|
408
|
+
<li>
|
409
|
+
<span class="name">search</span>
|
410
|
+
<span class="type">(<tt>String</tt>)</span>
|
411
|
+
<span class="default">
|
412
|
+
|
413
|
+
</span>
|
414
|
+
|
415
|
+
— <div class='inline'>
|
416
|
+
<p>filter results</p>
|
417
|
+
</div>
|
418
|
+
|
419
|
+
</li>
|
420
|
+
|
421
|
+
</ul>
|
422
|
+
|
423
|
+
|
424
|
+
|
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'>
|
438
|
+
<p>First item: parsed data; second item: raw body</p>
|
439
|
+
</div>
|
440
|
+
|
441
|
+
</li>
|
442
|
+
|
443
|
+
</ul>
|
444
|
+
|
445
|
+
</div><table class="source_code">
|
446
|
+
<tr>
|
447
|
+
<td>
|
448
|
+
<pre class="lines">
|
449
|
+
|
450
|
+
|
451
|
+
20
|
452
|
+
21
|
453
|
+
22</pre>
|
454
|
+
</td>
|
455
|
+
<td>
|
456
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/smart_class_parameter.rb', line 20</span>
|
457
|
+
|
458
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
459
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
460
|
+
<span class='kw'>end</span></pre>
|
461
|
+
</td>
|
462
|
+
</tr>
|
463
|
+
</table>
|
464
|
+
</div>
|
465
|
+
|
466
|
+
<div class="method_details ">
|
467
|
+
<h3 class="signature " id="show-instance_method">
|
468
|
+
|
469
|
+
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
</h3><div class="docstring">
|
476
|
+
<div class="discussion">
|
477
|
+
|
478
|
+
<p>Returns First item: parsed data; second item: raw body</p>
|
479
|
+
|
480
|
+
|
481
|
+
</div>
|
482
|
+
</div>
|
483
|
+
<div class="tags">
|
484
|
+
<p class="tag_title">Parameters:</p>
|
485
|
+
<ul class="param">
|
486
|
+
|
487
|
+
<li>
|
488
|
+
|
489
|
+
<span class='name'>params</span>
|
490
|
+
|
491
|
+
|
492
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
493
|
+
|
494
|
+
|
495
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
496
|
+
|
497
|
+
|
498
|
+
—
|
499
|
+
<div class='inline'>
|
500
|
+
<p>a hash of params to be passed to the service</p>
|
501
|
+
</div>
|
502
|
+
|
503
|
+
</li>
|
504
|
+
|
505
|
+
<li>
|
506
|
+
|
507
|
+
<span class='name'>headers</span>
|
508
|
+
|
509
|
+
|
510
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
511
|
+
|
512
|
+
|
513
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
514
|
+
|
515
|
+
|
516
|
+
—
|
517
|
+
<div class='inline'>
|
518
|
+
<p>additional http headers</p>
|
519
|
+
</div>
|
520
|
+
|
521
|
+
</li>
|
522
|
+
|
523
|
+
</ul>
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
|
528
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
529
|
+
<ul class="option">
|
530
|
+
|
531
|
+
<li>
|
532
|
+
<span class="name">id</span>
|
533
|
+
<span class="type">(<tt>String</tt>)</span>
|
534
|
+
<span class="default">
|
535
|
+
|
536
|
+
</span>
|
537
|
+
|
538
|
+
</li>
|
539
|
+
|
540
|
+
</ul>
|
541
|
+
|
542
|
+
|
543
|
+
|
544
|
+
|
545
|
+
<p class="tag_title">Returns:</p>
|
546
|
+
<ul class="return">
|
547
|
+
|
548
|
+
<li>
|
549
|
+
|
550
|
+
|
551
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
552
|
+
|
553
|
+
|
554
|
+
|
555
|
+
—
|
556
|
+
<div class='inline'>
|
557
|
+
<p>First item: parsed data; second item: raw body</p>
|
558
|
+
</div>
|
559
|
+
|
560
|
+
</li>
|
561
|
+
|
562
|
+
</ul>
|
563
|
+
|
564
|
+
</div><table class="source_code">
|
565
|
+
<tr>
|
566
|
+
<td>
|
567
|
+
<pre class="lines">
|
568
|
+
|
569
|
+
|
570
|
+
29
|
571
|
+
30
|
572
|
+
31</pre>
|
573
|
+
</td>
|
574
|
+
<td>
|
575
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/smart_class_parameter.rb', line 29</span>
|
576
|
+
|
577
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
578
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
579
|
+
<span class='kw'>end</span></pre>
|
580
|
+
</td>
|
581
|
+
</tr>
|
582
|
+
</table>
|
583
|
+
</div>
|
584
|
+
|
585
|
+
<div class="method_details ">
|
586
|
+
<h3 class="signature " id="update-instance_method">
|
587
|
+
|
588
|
+
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
|
589
|
+
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
|
594
|
+
</h3><div class="docstring">
|
595
|
+
<div class="discussion">
|
596
|
+
|
597
|
+
<p>Returns First item: parsed data; second item: raw body</p>
|
598
|
+
|
599
|
+
|
600
|
+
</div>
|
601
|
+
</div>
|
602
|
+
<div class="tags">
|
603
|
+
<p class="tag_title">Parameters:</p>
|
604
|
+
<ul class="param">
|
605
|
+
|
606
|
+
<li>
|
607
|
+
|
608
|
+
<span class='name'>params</span>
|
609
|
+
|
610
|
+
|
611
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
612
|
+
|
613
|
+
|
614
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
615
|
+
|
616
|
+
|
617
|
+
—
|
618
|
+
<div class='inline'>
|
619
|
+
<p>a hash of params to be passed to the service</p>
|
620
|
+
</div>
|
621
|
+
|
622
|
+
</li>
|
623
|
+
|
624
|
+
<li>
|
625
|
+
|
626
|
+
<span class='name'>headers</span>
|
627
|
+
|
628
|
+
|
629
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
630
|
+
|
631
|
+
|
632
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
633
|
+
|
634
|
+
|
635
|
+
—
|
636
|
+
<div class='inline'>
|
637
|
+
<p>additional http headers</p>
|
638
|
+
</div>
|
639
|
+
|
640
|
+
</li>
|
641
|
+
|
642
|
+
</ul>
|
643
|
+
|
644
|
+
|
645
|
+
|
646
|
+
|
647
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
648
|
+
<ul class="option">
|
649
|
+
|
650
|
+
<li>
|
651
|
+
<span class="name">id</span>
|
652
|
+
<span class="type">(<tt>String</tt>)</span>
|
653
|
+
<span class="default">
|
654
|
+
|
655
|
+
</span>
|
656
|
+
|
657
|
+
</li>
|
658
|
+
|
659
|
+
<li>
|
660
|
+
<span class="name">smart_class_parameter</span>
|
661
|
+
<span class="type">(<tt>Hash</tt>)</span>
|
662
|
+
<span class="default">
|
663
|
+
|
664
|
+
</span>
|
665
|
+
|
666
|
+
— <div class='inline'>
|
667
|
+
<p>allowed keys are:</p>
|
668
|
+
<ul><li>
|
669
|
+
<p>default_value [String]</p>
|
670
|
+
</li><li>
|
671
|
+
<p>description [String]</p>
|
672
|
+
</li><li>
|
673
|
+
<p>override [String]</p>
|
674
|
+
</li><li>
|
675
|
+
<p>override_value_order [String]</p>
|
676
|
+
</li><li>
|
677
|
+
<p>parameter_type [String]</p>
|
678
|
+
</li><li>
|
679
|
+
<p>path [String]</p>
|
680
|
+
</li><li>
|
681
|
+
<p>required [String]</p>
|
682
|
+
</li><li>
|
683
|
+
<p>validator_rule [String]</p>
|
684
|
+
</li><li>
|
685
|
+
<p>validator_type [String]</p>
|
686
|
+
</li></ul>
|
687
|
+
</div>
|
688
|
+
|
689
|
+
</li>
|
690
|
+
|
691
|
+
</ul>
|
692
|
+
|
693
|
+
|
694
|
+
|
695
|
+
|
696
|
+
<p class="tag_title">Returns:</p>
|
697
|
+
<ul class="return">
|
698
|
+
|
699
|
+
<li>
|
700
|
+
|
701
|
+
|
702
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
703
|
+
|
704
|
+
|
705
|
+
|
706
|
+
—
|
707
|
+
<div class='inline'>
|
708
|
+
<p>First item: parsed data; second item: raw body</p>
|
709
|
+
</div>
|
710
|
+
|
711
|
+
</li>
|
712
|
+
|
713
|
+
</ul>
|
714
|
+
|
715
|
+
</div><table class="source_code">
|
716
|
+
<tr>
|
717
|
+
<td>
|
718
|
+
<pre class="lines">
|
719
|
+
|
720
|
+
|
721
|
+
49
|
722
|
+
50
|
723
|
+
51</pre>
|
724
|
+
</td>
|
725
|
+
<td>
|
726
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/smart_class_parameter.rb', line 49</span>
|
727
|
+
|
728
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
729
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
730
|
+
<span class='kw'>end</span></pre>
|
731
|
+
</td>
|
732
|
+
</tr>
|
733
|
+
</table>
|
734
|
+
</div>
|
735
|
+
|
736
|
+
</div>
|
737
|
+
|
738
|
+
</div>
|
739
|
+
|
740
|
+
<div id="footer">
|
741
|
+
Generated on Mon Oct 21 11:10:47 2013 by
|
742
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
743
|
+
0.8.7 (ruby-2.0.0).
|
744
|
+
</div>
|
745
|
+
|
746
|
+
</body>
|
747
|
+
</html>
|