foreman_api 0.1.6 → 0.1.7

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.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/doc/ForemanApi.html +3 -3
  3. data/doc/ForemanApi/Resources.html +4 -4
  4. data/doc/ForemanApi/Resources/Architecture.html +7 -7
  5. data/doc/ForemanApi/Resources/Audit.html +5 -5
  6. data/doc/ForemanApi/Resources/AuthSourceLdap.html +15 -15
  7. data/doc/ForemanApi/Resources/Bookmark.html +3 -3
  8. data/doc/ForemanApi/Resources/CommonParameter.html +5 -5
  9. data/doc/ForemanApi/Resources/ComputeResource.html +167 -24
  10. data/doc/ForemanApi/Resources/ConfigTemplate.html +14 -14
  11. data/doc/ForemanApi/Resources/Dashboard.html +2 -2
  12. data/doc/ForemanApi/Resources/Domain.html +14 -14
  13. data/doc/ForemanApi/Resources/Environment.html +199 -25
  14. data/doc/ForemanApi/Resources/FactValue.html +5 -5
  15. data/doc/ForemanApi/Resources/Home.html +1 -1
  16. data/doc/ForemanApi/Resources/Host.html +509 -10
  17. data/doc/ForemanApi/Resources/HostClass.html +5 -5
  18. data/doc/ForemanApi/Resources/Hostgroup.html +5 -5
  19. data/doc/ForemanApi/Resources/HostgroupClass.html +5 -5
  20. data/doc/ForemanApi/Resources/Image.html +5 -5
  21. data/doc/ForemanApi/Resources/Interface.html +1045 -0
  22. data/doc/ForemanApi/Resources/Location.html +5 -5
  23. data/doc/ForemanApi/Resources/LookupKey.html +62 -811
  24. data/doc/ForemanApi/Resources/Medium.html +13 -13
  25. data/doc/ForemanApi/Resources/Model.html +5 -5
  26. data/doc/ForemanApi/Resources/OperatingSystem.html +5 -5
  27. data/doc/ForemanApi/Resources/Organization.html +5 -5
  28. data/doc/ForemanApi/Resources/OverrideValue.html +1060 -0
  29. data/doc/ForemanApi/Resources/Parameter.html +26 -26
  30. data/doc/ForemanApi/Resources/Ptable.html +5 -5
  31. data/doc/ForemanApi/Resources/Puppetclass.html +80 -28
  32. data/doc/ForemanApi/Resources/Report.html +164 -6
  33. data/doc/ForemanApi/Resources/Role.html +3 -3
  34. data/doc/ForemanApi/Resources/Setting.html +5 -5
  35. data/doc/ForemanApi/Resources/SmartClassParameter.html +747 -0
  36. data/doc/ForemanApi/Resources/SmartProxy.html +341 -24
  37. data/doc/ForemanApi/Resources/SmartVariable.html +1043 -0
  38. data/doc/ForemanApi/Resources/Statistic.html +330 -0
  39. data/doc/ForemanApi/Resources/Subnet.html +33 -33
  40. data/doc/ForemanApi/Resources/TemplateCombination.html +3 -3
  41. data/doc/ForemanApi/Resources/TemplateKind.html +3 -3
  42. data/doc/ForemanApi/Resources/User.html +7 -7
  43. data/doc/ForemanApi/Resources/Usergroup.html +5 -5
  44. data/doc/_index.html +36 -1
  45. data/doc/class_list.html +1 -1
  46. data/doc/file.MIT-LICENSE.html +1 -1
  47. data/doc/file.README.html +1 -1
  48. data/doc/index.html +1 -1
  49. data/doc/method_list.html +515 -347
  50. data/doc/top-level-namespace.html +1 -1
  51. data/lib/foreman_api/base.rb +2 -1
  52. data/lib/foreman_api/documentation.json +1 -1
  53. data/lib/foreman_api/resources/architecture.rb +6 -6
  54. data/lib/foreman_api/resources/audit.rb +4 -4
  55. data/lib/foreman_api/resources/auth_source_ldap.rb +14 -14
  56. data/lib/foreman_api/resources/bookmark.rb +2 -2
  57. data/lib/foreman_api/resources/common_parameter.rb +4 -4
  58. data/lib/foreman_api/resources/compute_resource.rb +29 -20
  59. data/lib/foreman_api/resources/config_template.rb +13 -13
  60. data/lib/foreman_api/resources/dashboard.rb +1 -1
  61. data/lib/foreman_api/resources/domain.rb +13 -13
  62. data/lib/foreman_api/resources/environment.rb +16 -4
  63. data/lib/foreman_api/resources/fact_value.rb +4 -4
  64. data/lib/foreman_api/resources/host.rb +40 -8
  65. data/lib/foreman_api/resources/host_class.rb +4 -4
  66. data/lib/foreman_api/resources/hostgroup.rb +4 -4
  67. data/lib/foreman_api/resources/hostgroup_class.rb +4 -4
  68. data/lib/foreman_api/resources/image.rb +4 -4
  69. data/lib/foreman_api/resources/interface.rb +80 -0
  70. data/lib/foreman_api/resources/location.rb +4 -4
  71. data/lib/foreman_api/resources/lookup_key.rb +6 -65
  72. data/lib/foreman_api/resources/medium.rb +10 -10
  73. data/lib/foreman_api/resources/model.rb +4 -4
  74. data/lib/foreman_api/resources/operating_system.rb +4 -4
  75. data/lib/foreman_api/resources/organization.rb +4 -4
  76. data/lib/foreman_api/resources/override_value.rb +73 -0
  77. data/lib/foreman_api/resources/parameter.rb +25 -25
  78. data/lib/foreman_api/resources/ptable.rb +4 -4
  79. data/lib/foreman_api/resources/puppetclass.rb +11 -7
  80. data/lib/foreman_api/resources/report.rb +19 -4
  81. data/lib/foreman_api/resources/role.rb +2 -2
  82. data/lib/foreman_api/resources/setting.rb +4 -4
  83. data/lib/foreman_api/resources/smart_class_parameter.rb +55 -0
  84. data/lib/foreman_api/resources/smart_proxy.rb +24 -3
  85. data/lib/foreman_api/resources/smart_variable.rb +80 -0
  86. data/lib/foreman_api/resources/statistic.rb +18 -0
  87. data/lib/foreman_api/resources/subnet.rb +32 -32
  88. data/lib/foreman_api/resources/template_combination.rb +2 -2
  89. data/lib/foreman_api/resources/template_kind.rb +2 -2
  90. data/lib/foreman_api/resources/user.rb +6 -6
  91. data/lib/foreman_api/resources/usergroup.rb +4 -4
  92. data/lib/foreman_api/version.rb +1 -1
  93. metadata +13 -3
@@ -0,0 +1,330 @@
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::Statistic
8
+
9
+ &mdash; 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> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
36
+ &raquo;
37
+ <span class="title">Statistic</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::Statistic
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::Statistic</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/statistic.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
+ </ul>
175
+
176
+
177
+
178
+
179
+
180
+ <div id="class_method_details" class="method_details_list">
181
+ <h2>Class Method Details</h2>
182
+
183
+
184
+ <div class="method_details first">
185
+ <h3 class="signature first" id="doc-class_method">
186
+
187
+ + (<tt>Object</tt>) <strong>doc</strong>
188
+
189
+
190
+
191
+
192
+
193
+ </h3><table class="source_code">
194
+ <tr>
195
+ <td>
196
+ <pre class="lines">
197
+
198
+
199
+ 4
200
+ 5
201
+ 6</pre>
202
+ </td>
203
+ <td>
204
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/statistic.rb', line 4</span>
205
+
206
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
207
+ <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'>&#39;</span><span class='tstring_content'>resources</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>statistics</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
208
+ <span class='kw'>end</span></pre>
209
+ </td>
210
+ </tr>
211
+ </table>
212
+ </div>
213
+
214
+ </div>
215
+
216
+ <div id="instance_method_details" class="method_details_list">
217
+ <h2>Instance Method Details</h2>
218
+
219
+
220
+ <div class="method_details first">
221
+ <h3 class="signature first" id="index-instance_method">
222
+
223
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
224
+
225
+
226
+
227
+
228
+
229
+ </h3><div class="docstring">
230
+ <div class="discussion">
231
+
232
+ <p>Returns First item: parsed data; second item: raw body</p>
233
+
234
+
235
+ </div>
236
+ </div>
237
+ <div class="tags">
238
+ <p class="tag_title">Parameters:</p>
239
+ <ul class="param">
240
+
241
+ <li>
242
+
243
+ <span class='name'>params</span>
244
+
245
+
246
+ <span class='type'>(<tt>Hash</tt>)</span>
247
+
248
+
249
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
250
+
251
+
252
+ &mdash;
253
+ <div class='inline'>
254
+ <p>a hash of params to be passed to the service</p>
255
+ </div>
256
+
257
+ </li>
258
+
259
+ <li>
260
+
261
+ <span class='name'>headers</span>
262
+
263
+
264
+ <span class='type'>(<tt>Hash</tt>)</span>
265
+
266
+
267
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
268
+
269
+
270
+ &mdash;
271
+ <div class='inline'>
272
+ <p>additional http headers</p>
273
+ </div>
274
+
275
+ </li>
276
+
277
+ </ul>
278
+
279
+ <p class="tag_title">Returns:</p>
280
+ <ul class="return">
281
+
282
+ <li>
283
+
284
+
285
+ <span class='type'>(<tt>Array</tt>)</span>
286
+
287
+
288
+
289
+ &mdash;
290
+ <div class='inline'>
291
+ <p>First item: parsed data; second item: raw body</p>
292
+ </div>
293
+
294
+ </li>
295
+
296
+ </ul>
297
+
298
+ </div><table class="source_code">
299
+ <tr>
300
+ <td>
301
+ <pre class="lines">
302
+
303
+
304
+ 12
305
+ 13
306
+ 14</pre>
307
+ </td>
308
+ <td>
309
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/statistic.rb', line 12</span>
310
+
311
+ <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>
312
+ <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>
313
+ <span class='kw'>end</span></pre>
314
+ </td>
315
+ </tr>
316
+ </table>
317
+ </div>
318
+
319
+ </div>
320
+
321
+ </div>
322
+
323
+ <div id="footer">
324
+ Generated on Mon Oct 21 11:10:45 2013 by
325
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
326
+ 0.8.7 (ruby-2.0.0).
327
+ </div>
328
+
329
+ </body>
330
+ </html>
@@ -388,31 +388,31 @@
388
388
  &mdash; <div class='inline'>
389
389
  <p>allowed keys are:</p>
390
390
  <ul><li>
391
- <p>dhcp_id [String] Dhcp proxy to use within this subnet</p>
391
+ <p>dhcp_id [String] dhcp proxy to use within this subnet</p>
392
392
  </li><li>
393
- <p>dns_id [String] Dns proxy to use within this subnet</p>
393
+ <p>dns_id [String] dns proxy to use within this subnet</p>
394
394
  </li><li>
395
- <p>domain_ids [Array] Domains in which this subnet is part</p>
395
+ <p>domain_ids [Array] domains in which this subnet is part</p>
396
396
  </li><li>
397
- <p>tftp_id [String] Tftp proxy to use within this subnet</p>
397
+ <p>tftp_id [String] tftp proxy to use within this subnet</p>
398
398
  </li><li>
399
- <p>dns_primary [String] Primary dns for this subnet</p>
399
+ <p>dns_primary [String] primary dns for this subnet</p>
400
400
  </li><li>
401
- <p>dns_secondary [String] Secondary dns for this subnet</p>
401
+ <p>dns_secondary [String] secondary dns for this subnet</p>
402
402
  </li><li>
403
- <p>from [String] Starting ip address for ip auto suggestion</p>
403
+ <p>from [String] starting ip address for ip auto suggestion</p>
404
404
  </li><li>
405
- <p>gateway [String] Primary dns for this subnet</p>
405
+ <p>gateway [String] primary dns for this subnet</p>
406
406
  </li><li>
407
- <p>mask [String] Netmask for this subnet</p>
407
+ <p>mask [String] netmask for this subnet</p>
408
408
  </li><li>
409
- <p>name [String] Subnet name</p>
409
+ <p>name [String] subnet name</p>
410
410
  </li><li>
411
- <p>network [String] Subnet network</p>
411
+ <p>network [String] subnet network</p>
412
412
  </li><li>
413
- <p>to [String] Ending ip address for ip auto suggestion</p>
413
+ <p>to [String] ending ip address for ip auto suggestion</p>
414
414
  </li><li>
415
- <p>vlanid [String] Vlan id for this subnet</p>
415
+ <p>vlanid [String] vlan id for this subnet</p>
416
416
  </li></ul>
417
417
  </div>
418
418
 
@@ -536,7 +536,7 @@
536
536
  </span>
537
537
 
538
538
  &mdash; <div class='inline'>
539
- <p>Subnet numeric identifier</p>
539
+ <p>subnet numeric identifier</p>
540
540
  </div>
541
541
 
542
542
  </li>
@@ -659,7 +659,7 @@
659
659
  </span>
660
660
 
661
661
  &mdash; <div class='inline'>
662
- <p>Sort results</p>
662
+ <p>sort results</p>
663
663
  </div>
664
664
 
665
665
  </li>
@@ -672,7 +672,7 @@
672
672
  </span>
673
673
 
674
674
  &mdash; <div class='inline'>
675
- <p>Paginate results</p>
675
+ <p>paginate results</p>
676
676
  </div>
677
677
 
678
678
  </li>
@@ -685,7 +685,7 @@
685
685
  </span>
686
686
 
687
687
  &mdash; <div class='inline'>
688
- <p>Number of entries per request</p>
688
+ <p>number of entries per request</p>
689
689
  </div>
690
690
 
691
691
  </li>
@@ -698,7 +698,7 @@
698
698
  </span>
699
699
 
700
700
  &mdash; <div class='inline'>
701
- <p>Filter results</p>
701
+ <p>filter results</p>
702
702
  </div>
703
703
 
704
704
  </li>
@@ -940,7 +940,7 @@
940
940
  </span>
941
941
 
942
942
  &mdash; <div class='inline'>
943
- <p>Subnet numeric identifier</p>
943
+ <p>subnet numeric identifier</p>
944
944
  </div>
945
945
 
946
946
  </li>
@@ -955,31 +955,31 @@
955
955
  &mdash; <div class='inline'>
956
956
  <p>allowed keys are:</p>
957
957
  <ul><li>
958
- <p>dhcp_id [String, nil] Dhcp proxy to use within this subnet</p>
958
+ <p>dhcp_id [String, nil] dhcp proxy to use within this subnet</p>
959
959
  </li><li>
960
- <p>dns_id [String, nil] Dns proxy to use within this subnet</p>
960
+ <p>dns_id [String, nil] dns proxy to use within this subnet</p>
961
961
  </li><li>
962
- <p>domain_ids [Array, nil] Domains in which this subnet is part</p>
962
+ <p>domain_ids [Array, nil] domains in which this subnet is part</p>
963
963
  </li><li>
964
- <p>tftp_id [String, nil] Tftp proxy to use within this subnet</p>
964
+ <p>tftp_id [String, nil] tftp proxy to use within this subnet</p>
965
965
  </li><li>
966
- <p>dns_primary [String, nil] Primary dns for this subnet</p>
966
+ <p>dns_primary [String, nil] primary dns for this subnet</p>
967
967
  </li><li>
968
- <p>dns_secondary [String, nil] Secondary dns for this subnet</p>
968
+ <p>dns_secondary [String, nil] secondary dns for this subnet</p>
969
969
  </li><li>
970
- <p>from [String, nil] Starting ip address for ip auto suggestion</p>
970
+ <p>from [String, nil] starting ip address for ip auto suggestion</p>
971
971
  </li><li>
972
- <p>gateway [String, nil] Primary dns for this subnet</p>
972
+ <p>gateway [String, nil] primary dns for this subnet</p>
973
973
  </li><li>
974
- <p>mask [String] Netmask for this subnet</p>
974
+ <p>mask [String] netmask for this subnet</p>
975
975
  </li><li>
976
- <p>name [String] Subnet name</p>
976
+ <p>name [String] subnet name</p>
977
977
  </li><li>
978
- <p>network [String] Subnet network</p>
978
+ <p>network [String] subnet network</p>
979
979
  </li><li>
980
- <p>to [String, nil] Ending ip address for ip auto suggestion</p>
980
+ <p>to [String, nil] ending ip address for ip auto suggestion</p>
981
981
  </li><li>
982
- <p>vlanid [String, nil] Vlan id for this subnet</p>
982
+ <p>vlanid [String, nil] vlan id for this subnet</p>
983
983
  </li></ul>
984
984
  </div>
985
985
 
@@ -1035,7 +1035,7 @@
1035
1035
  </div>
1036
1036
 
1037
1037
  <div id="footer">
1038
- Generated on Mon Aug 26 13:05:13 2013 by
1038
+ Generated on Mon Oct 21 11:10:44 2013 by
1039
1039
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1040
1040
  0.8.7 (ruby-2.0.0).
1041
1041
  </div>