foreman_api 0.0.10 → 0.0.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. data/.yardopts +4 -0
  2. data/Gemfile +5 -0
  3. data/README.rdoc +23 -4
  4. data/doc/ForemanApi/Resources/Architecture.html +902 -0
  5. data/doc/ForemanApi/Resources/Audit.html +500 -0
  6. data/doc/ForemanApi/Resources/AuthSourceLdap.html +916 -0
  7. data/doc/ForemanApi/Resources/Bookmark.html +884 -0
  8. data/doc/ForemanApi/Resources/CommonParameter.html +902 -0
  9. data/doc/ForemanApi/Resources/ComputeResource.html +940 -0
  10. data/doc/ForemanApi/Resources/ConfigTemplate.html +1160 -0
  11. data/doc/ForemanApi/Resources/Dashboard.html +336 -0
  12. data/doc/ForemanApi/Resources/Domain.html +914 -0
  13. data/doc/ForemanApi/Resources/Environment.html +898 -0
  14. data/doc/ForemanApi/Resources/FactValue.html +375 -0
  15. data/doc/ForemanApi/Resources/Home.html +417 -0
  16. data/doc/ForemanApi/Resources/Host.html +1091 -0
  17. data/doc/ForemanApi/Resources/Hostgroup.html +934 -0
  18. data/doc/ForemanApi/Resources/Image.html +963 -0
  19. data/doc/ForemanApi/Resources/LookupKey.html +918 -0
  20. data/doc/ForemanApi/Resources/Medium.html +920 -0
  21. data/doc/ForemanApi/Resources/Model.html +910 -0
  22. data/doc/ForemanApi/Resources/OperatingSystem.html +1057 -0
  23. data/doc/ForemanApi/Resources/Ptable.html +906 -0
  24. data/doc/ForemanApi/Resources/Puppetclass.html +898 -0
  25. data/doc/ForemanApi/Resources/Report.html +625 -0
  26. data/doc/ForemanApi/Resources/Role.html +872 -0
  27. data/doc/ForemanApi/Resources/Setting.html +641 -0
  28. data/doc/ForemanApi/Resources/SmartProxy.html +889 -0
  29. data/doc/ForemanApi/Resources/Subnet.html +954 -0
  30. data/doc/ForemanApi/Resources/TemplateKind.html +349 -0
  31. data/doc/ForemanApi/Resources/User.html +920 -0
  32. data/doc/ForemanApi/Resources/Usergroup.html +872 -0
  33. data/doc/ForemanApi/Resources.html +117 -0
  34. data/doc/ForemanApi.html +117 -0
  35. data/doc/_index.html +449 -0
  36. data/doc/class_list.html +53 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +57 -0
  39. data/doc/css/style.css +328 -0
  40. data/doc/file.MIT-LICENSE.html +93 -0
  41. data/doc/file.README.html +129 -0
  42. data/doc/file_list.html +58 -0
  43. data/doc/frames.html +28 -0
  44. data/doc/index.html +129 -0
  45. data/doc/js/app.js +214 -0
  46. data/doc/js/full_list.js +173 -0
  47. data/doc/js/jquery.js +4 -0
  48. data/doc/method_list.html +1300 -0
  49. data/doc/top-level-namespace.html +112 -0
  50. data/foreman_api.gemspec +5 -2
  51. data/lib/foreman_api/base.rb +129 -0
  52. data/lib/foreman_api/resources/architecture.rb +17 -7
  53. data/lib/foreman_api/resources/audit.rb +7 -4
  54. data/lib/foreman_api/resources/auth_source_ldap.rb +35 -7
  55. data/lib/foreman_api/resources/bookmark.rb +19 -7
  56. data/lib/foreman_api/resources/common_parameter.rb +17 -7
  57. data/lib/foreman_api/resources/compute_resource.rb +33 -7
  58. data/lib/foreman_api/resources/config_template.rb +28 -9
  59. data/lib/foreman_api/resources/dashboard.rb +3 -3
  60. data/lib/foreman_api/resources/domain.rb +21 -7
  61. data/lib/foreman_api/resources/environment.rb +15 -7
  62. data/lib/foreman_api/resources/fact_value.rb +6 -3
  63. data/lib/foreman_api/resources/home.rb +2 -4
  64. data/lib/foreman_api/resources/host.rb +50 -8
  65. data/lib/foreman_api/resources/hostgroup.rb +33 -7
  66. data/lib/foreman_api/resources/image.rb +30 -7
  67. data/lib/foreman_api/resources/lookup_key.rb +25 -7
  68. data/lib/foreman_api/resources/medium.rb +19 -7
  69. data/lib/foreman_api/resources/model.rb +21 -7
  70. data/lib/foreman_api/resources/operating_system.rb +26 -8
  71. data/lib/foreman_api/resources/ptable.rb +19 -7
  72. data/lib/foreman_api/resources/puppetclass.rb +15 -7
  73. data/lib/foreman_api/resources/report.rb +8 -5
  74. data/lib/foreman_api/resources/role.rb +13 -7
  75. data/lib/foreman_api/resources/setting.rb +11 -5
  76. data/lib/foreman_api/resources/smart_proxy.rb +16 -7
  77. data/lib/foreman_api/resources/subnet.rb +39 -7
  78. data/lib/foreman_api/resources/template_kind.rb +4 -3
  79. data/lib/foreman_api/resources/user.rb +26 -7
  80. data/lib/foreman_api/resources/usergroup.rb +13 -7
  81. data/lib/foreman_api/rest_client_oauth.rb +19 -0
  82. data/lib/foreman_api/version.rb +1 -1
  83. data/lib/foreman_api.rb +6 -10
  84. metadata +51 -18
data/doc/ForemanApi/Resources/ConfigTemplate.html ADDED
@@ -0,0 +1,1160 @@
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::ConfigTemplate
8
+
9
+ &mdash; Documentation by YARD 0.8.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" 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 (C)</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">ConfigTemplate</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::ConfigTemplate
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::ConfigTemplate</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/config_template.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="#build_pxe_default-instance_method" title="#build_pxe_default (instance method)">- (Object) <strong>build_pxe_default</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'></div></span>
168
+
169
+ </li>
170
+
171
+
172
+ <li class="public ">
173
+ <span class="summary_signature">
174
+
175
+ <a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong>(params = { }, headers = { }) </a>
176
+
177
+
178
+
179
+ </span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'></div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(params = { }, headers = { }) </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'></div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong>(params = { }, headers = { }) </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'></div></span>
234
+
235
+ </li>
236
+
237
+
238
+ <li class="public ">
239
+ <span class="summary_signature">
240
+
241
+ <a href="#revision-instance_method" title="#revision (instance method)">- (Object) <strong>revision</strong>(params = { }, headers = { }) </a>
242
+
243
+
244
+
245
+ </span>
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+ <span class="summary_desc"><div class='inline'></div></span>
256
+
257
+ </li>
258
+
259
+
260
+ <li class="public ">
261
+ <span class="summary_signature">
262
+
263
+ <a href="#show-instance_method" title="#show (instance method)">- (Object) <strong>show</strong>(params = { }, headers = { }) </a>
264
+
265
+
266
+
267
+ </span>
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <span class="summary_desc"><div class='inline'></div></span>
278
+
279
+ </li>
280
+
281
+
282
+ <li class="public ">
283
+ <span class="summary_signature">
284
+
285
+ <a href="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</strong>(params = { }, headers = { }) </a>
286
+
287
+
288
+
289
+ </span>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+ <span class="summary_desc"><div class='inline'></div></span>
300
+
301
+ </li>
302
+
303
+
304
+ </ul>
305
+
306
+
307
+
308
+
309
+
310
+ <div id="class_method_details" class="method_details_list">
311
+ <h2>Class Method Details</h2>
312
+
313
+
314
+ <div class="method_details first">
315
+ <h3 class="signature first" id="doc-class_method">
316
+
317
+ + (<tt>Object</tt>) <strong>doc</strong>
318
+
319
+
320
+
321
+
322
+
323
+ </h3><table class="source_code">
324
+ <tr>
325
+ <td>
326
+ <pre class="lines">
327
+
328
+
329
+ 4
330
+ 5
331
+ 6</pre>
332
+ </td>
333
+ <td>
334
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 4</span>
335
+
336
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
337
+ <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'>&quot;</span><span class='tstring_content'>config_templates</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
338
+ <span class='kw'>end</span></pre>
339
+ </td>
340
+ </tr>
341
+ </table>
342
+ </div>
343
+
344
+ </div>
345
+
346
+ <div id="instance_method_details" class="method_details_list">
347
+ <h2>Instance Method Details</h2>
348
+
349
+
350
+ <div class="method_details first">
351
+ <h3 class="signature first" id="build_pxe_default-instance_method">
352
+
353
+ - (<tt>Object</tt>) <strong>build_pxe_default</strong>(params = { }, headers = { })
354
+
355
+
356
+
357
+
358
+
359
+ </h3><div class="docstring">
360
+ <div class="discussion">
361
+
362
+
363
+ </div>
364
+ </div>
365
+ <div class="tags">
366
+ <p class="tag_title">Parameters:</p>
367
+ <ul class="param">
368
+
369
+ <li>
370
+
371
+ <span class='name'>params</span>
372
+
373
+
374
+ <span class='type'>(<tt>Hash</tt>)</span>
375
+
376
+
377
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
378
+
379
+
380
+ &mdash;
381
+ <div class='inline'>
382
+ <p>a hash of params to be passed to the service</p>
383
+ </div>
384
+
385
+ </li>
386
+
387
+ <li>
388
+
389
+ <span class='name'>headers</span>
390
+
391
+
392
+ <span class='type'>(<tt>Hash</tt>)</span>
393
+
394
+
395
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
396
+
397
+
398
+ &mdash;
399
+ <div class='inline'>
400
+ <p>additional http headers</p>
401
+ </div>
402
+
403
+ </li>
404
+
405
+ </ul>
406
+
407
+
408
+ </div><table class="source_code">
409
+ <tr>
410
+ <td>
411
+ <pre class="lines">
412
+
413
+
414
+ 91
415
+ 92
416
+ 93
417
+ 94
418
+ 95</pre>
419
+ </td>
420
+ <td>
421
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 91</span>
422
+
423
+ <span class='kw'>def</span> <span class='id identifier rubyid_build_pxe_default'>build_pxe_default</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>
424
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
425
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates/build_pxe_default</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
426
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
427
+ <span class='kw'>end</span></pre>
428
+ </td>
429
+ </tr>
430
+ </table>
431
+ </div>
432
+
433
+ <div class="method_details ">
434
+ <h3 class="signature " id="create-instance_method">
435
+
436
+ - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
437
+
438
+
439
+
440
+
441
+
442
+ </h3><div class="docstring">
443
+ <div class="discussion">
444
+
445
+
446
+ </div>
447
+ </div>
448
+ <div class="tags">
449
+ <p class="tag_title">Parameters:</p>
450
+ <ul class="param">
451
+
452
+ <li>
453
+
454
+ <span class='name'>params</span>
455
+
456
+
457
+ <span class='type'>(<tt>Hash</tt>)</span>
458
+
459
+
460
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
461
+
462
+
463
+ &mdash;
464
+ <div class='inline'>
465
+ <p>a hash of params to be passed to the service</p>
466
+ </div>
467
+
468
+ </li>
469
+
470
+ <li>
471
+
472
+ <span class='name'>headers</span>
473
+
474
+
475
+ <span class='type'>(<tt>Hash</tt>)</span>
476
+
477
+
478
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
479
+
480
+
481
+ &mdash;
482
+ <div class='inline'>
483
+ <p>additional http headers</p>
484
+ </div>
485
+
486
+ </li>
487
+
488
+ </ul>
489
+
490
+
491
+
492
+
493
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
494
+ <ul class="option">
495
+
496
+ <li>
497
+ <span class="name">config_template</span>
498
+ <span class="type">(<tt>Hash</tt>)</span>
499
+ <span class="default">
500
+
501
+ </span>
502
+
503
+ &mdash; <div class='inline'>
504
+ <p>allowed keys are:</p>
505
+ <ul><li>
506
+ <p>audit_comment [String, nil],</p>
507
+ </li><li>
508
+ <p>name [String] Template name ,</p>
509
+ </li><li>
510
+ <p>operatingsystem_ids [String] Array of operating systems id to associate the
511
+ template with ,</p>
512
+ </li><li>
513
+ <p>snippet [String, nil],</p>
514
+ </li><li>
515
+ <p>template [String],</p>
516
+ </li><li>
517
+ <p>template_combinations_attributes [String] Array of template combinations
518
+ (hostgroupid, environmentid) ,</p>
519
+ </li><li>
520
+ <p>template_kind_id [String, nil] Not relevant for snippet ,</p>
521
+ </li></ul>
522
+ </div>
523
+
524
+ </li>
525
+
526
+ </ul>
527
+
528
+
529
+
530
+
531
+
532
+ </div><table class="source_code">
533
+ <tr>
534
+ <td>
535
+ <pre class="lines">
536
+
537
+
538
+ 43
539
+ 44
540
+ 45
541
+ 46
542
+ 47</pre>
543
+ </td>
544
+ <td>
545
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 43</span>
546
+
547
+ <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>
548
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
549
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
550
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:post</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
551
+ <span class='kw'>end</span></pre>
552
+ </td>
553
+ </tr>
554
+ </table>
555
+ </div>
556
+
557
+ <div class="method_details ">
558
+ <h3 class="signature " id="destroy-instance_method">
559
+
560
+ - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
561
+
562
+
563
+
564
+
565
+
566
+ </h3><div class="docstring">
567
+ <div class="discussion">
568
+
569
+
570
+ </div>
571
+ </div>
572
+ <div class="tags">
573
+ <p class="tag_title">Parameters:</p>
574
+ <ul class="param">
575
+
576
+ <li>
577
+
578
+ <span class='name'>params</span>
579
+
580
+
581
+ <span class='type'>(<tt>Hash</tt>)</span>
582
+
583
+
584
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
585
+
586
+
587
+ &mdash;
588
+ <div class='inline'>
589
+ <p>a hash of params to be passed to the service</p>
590
+ </div>
591
+
592
+ </li>
593
+
594
+ <li>
595
+
596
+ <span class='name'>headers</span>
597
+
598
+
599
+ <span class='type'>(<tt>Hash</tt>)</span>
600
+
601
+
602
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
603
+
604
+
605
+ &mdash;
606
+ <div class='inline'>
607
+ <p>additional http headers</p>
608
+ </div>
609
+
610
+ </li>
611
+
612
+ </ul>
613
+
614
+
615
+
616
+
617
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
618
+ <ul class="option">
619
+
620
+ <li>
621
+ <span class="name">id</span>
622
+ <span class="type">(<tt>String</tt>)</span>
623
+ <span class="default">
624
+
625
+ </span>
626
+
627
+ </li>
628
+
629
+ </ul>
630
+
631
+
632
+
633
+
634
+
635
+ </div><table class="source_code">
636
+ <tr>
637
+ <td>
638
+ <pre class="lines">
639
+
640
+
641
+ 82
642
+ 83
643
+ 84
644
+ 85
645
+ 86</pre>
646
+ </td>
647
+ <td>
648
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 82</span>
649
+
650
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</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>
651
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
652
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
653
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:delete</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
654
+ <span class='kw'>end</span></pre>
655
+ </td>
656
+ </tr>
657
+ </table>
658
+ </div>
659
+
660
+ <div class="method_details ">
661
+ <h3 class="signature " id="index-instance_method">
662
+
663
+ - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
664
+
665
+
666
+
667
+
668
+
669
+ </h3><div class="docstring">
670
+ <div class="discussion">
671
+
672
+
673
+ </div>
674
+ </div>
675
+ <div class="tags">
676
+ <p class="tag_title">Parameters:</p>
677
+ <ul class="param">
678
+
679
+ <li>
680
+
681
+ <span class='name'>params</span>
682
+
683
+
684
+ <span class='type'>(<tt>Hash</tt>)</span>
685
+
686
+
687
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
688
+
689
+
690
+ &mdash;
691
+ <div class='inline'>
692
+ <p>a hash of params to be passed to the service</p>
693
+ </div>
694
+
695
+ </li>
696
+
697
+ <li>
698
+
699
+ <span class='name'>headers</span>
700
+
701
+
702
+ <span class='type'>(<tt>Hash</tt>)</span>
703
+
704
+
705
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
706
+
707
+
708
+ &mdash;
709
+ <div class='inline'>
710
+ <p>additional http headers</p>
711
+ </div>
712
+
713
+ </li>
714
+
715
+ </ul>
716
+
717
+
718
+
719
+
720
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
721
+ <ul class="option">
722
+
723
+ <li>
724
+ <span class="name">order</span>
725
+ <span class="type">(<tt>String</tt>)</span>
726
+ <span class="default">
727
+
728
+ </span>
729
+
730
+ &mdash; <div class='inline'>
731
+ <p>Sort results</p>
732
+ </div>
733
+
734
+ </li>
735
+
736
+ <li>
737
+ <span class="name">page</span>
738
+ <span class="type">(<tt>String</tt>)</span>
739
+ <span class="default">
740
+
741
+ </span>
742
+
743
+ &mdash; <div class='inline'>
744
+ <p>Paginate results</p>
745
+ </div>
746
+
747
+ </li>
748
+
749
+ <li>
750
+ <span class="name">per_page</span>
751
+ <span class="type">(<tt>String</tt>)</span>
752
+ <span class="default">
753
+
754
+ </span>
755
+
756
+ &mdash; <div class='inline'>
757
+ <p>Number of entries per request</p>
758
+ </div>
759
+
760
+ </li>
761
+
762
+ <li>
763
+ <span class="name">search</span>
764
+ <span class="type">(<tt>String</tt>)</span>
765
+ <span class="default">
766
+
767
+ </span>
768
+
769
+ &mdash; <div class='inline'>
770
+ <p>Filter results</p>
771
+ </div>
772
+
773
+ </li>
774
+
775
+ </ul>
776
+
777
+
778
+
779
+
780
+
781
+ </div><table class="source_code">
782
+ <tr>
783
+ <td>
784
+ <pre class="lines">
785
+
786
+
787
+ 15
788
+ 16
789
+ 17
790
+ 18
791
+ 19</pre>
792
+ </td>
793
+ <td>
794
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 15</span>
795
+
796
+ <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>
797
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
798
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
799
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
800
+ <span class='kw'>end</span></pre>
801
+ </td>
802
+ </tr>
803
+ </table>
804
+ </div>
805
+
806
+ <div class="method_details ">
807
+ <h3 class="signature " id="revision-instance_method">
808
+
809
+ - (<tt>Object</tt>) <strong>revision</strong>(params = { }, headers = { })
810
+
811
+
812
+
813
+
814
+
815
+ </h3><div class="docstring">
816
+ <div class="discussion">
817
+
818
+
819
+ </div>
820
+ </div>
821
+ <div class="tags">
822
+ <p class="tag_title">Parameters:</p>
823
+ <ul class="param">
824
+
825
+ <li>
826
+
827
+ <span class='name'>params</span>
828
+
829
+
830
+ <span class='type'>(<tt>Hash</tt>)</span>
831
+
832
+
833
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
834
+
835
+
836
+ &mdash;
837
+ <div class='inline'>
838
+ <p>a hash of params to be passed to the service</p>
839
+ </div>
840
+
841
+ </li>
842
+
843
+ <li>
844
+
845
+ <span class='name'>headers</span>
846
+
847
+
848
+ <span class='type'>(<tt>Hash</tt>)</span>
849
+
850
+
851
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
852
+
853
+
854
+ &mdash;
855
+ <div class='inline'>
856
+ <p>additional http headers</p>
857
+ </div>
858
+
859
+ </li>
860
+
861
+ </ul>
862
+
863
+
864
+
865
+
866
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
867
+ <ul class="option">
868
+
869
+ <li>
870
+ <span class="name">version</span>
871
+ <span class="type">(<tt>String</tt>)</span>
872
+ <span class="default">
873
+
874
+ </span>
875
+
876
+ &mdash; <div class='inline'>
877
+ <p>Template version</p>
878
+ </div>
879
+
880
+ </li>
881
+
882
+ </ul>
883
+
884
+
885
+
886
+
887
+
888
+ </div><table class="source_code">
889
+ <tr>
890
+ <td>
891
+ <pre class="lines">
892
+
893
+
894
+ 72
895
+ 73
896
+ 74
897
+ 75
898
+ 76</pre>
899
+ </td>
900
+ <td>
901
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 72</span>
902
+
903
+ <span class='kw'>def</span> <span class='id identifier rubyid_revision'>revision</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>
904
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
905
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates/revision</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
906
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
907
+ <span class='kw'>end</span></pre>
908
+ </td>
909
+ </tr>
910
+ </table>
911
+ </div>
912
+
913
+ <div class="method_details ">
914
+ <h3 class="signature " id="show-instance_method">
915
+
916
+ - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
917
+
918
+
919
+
920
+
921
+
922
+ </h3><div class="docstring">
923
+ <div class="discussion">
924
+
925
+
926
+ </div>
927
+ </div>
928
+ <div class="tags">
929
+ <p class="tag_title">Parameters:</p>
930
+ <ul class="param">
931
+
932
+ <li>
933
+
934
+ <span class='name'>params</span>
935
+
936
+
937
+ <span class='type'>(<tt>Hash</tt>)</span>
938
+
939
+
940
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
941
+
942
+
943
+ &mdash;
944
+ <div class='inline'>
945
+ <p>a hash of params to be passed to the service</p>
946
+ </div>
947
+
948
+ </li>
949
+
950
+ <li>
951
+
952
+ <span class='name'>headers</span>
953
+
954
+
955
+ <span class='type'>(<tt>Hash</tt>)</span>
956
+
957
+
958
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
959
+
960
+
961
+ &mdash;
962
+ <div class='inline'>
963
+ <p>additional http headers</p>
964
+ </div>
965
+
966
+ </li>
967
+
968
+ </ul>
969
+
970
+
971
+
972
+
973
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
974
+ <ul class="option">
975
+
976
+ <li>
977
+ <span class="name">id</span>
978
+ <span class="type">(<tt>String</tt>)</span>
979
+ <span class="default">
980
+
981
+ </span>
982
+
983
+ </li>
984
+
985
+ </ul>
986
+
987
+
988
+
989
+
990
+
991
+ </div><table class="source_code">
992
+ <tr>
993
+ <td>
994
+ <pre class="lines">
995
+
996
+
997
+ 25
998
+ 26
999
+ 27
1000
+ 28
1001
+ 29</pre>
1002
+ </td>
1003
+ <td>
1004
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 25</span>
1005
+
1006
+ <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>
1007
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
1008
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
1009
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
1010
+ <span class='kw'>end</span></pre>
1011
+ </td>
1012
+ </tr>
1013
+ </table>
1014
+ </div>
1015
+
1016
+ <div class="method_details ">
1017
+ <h3 class="signature " id="update-instance_method">
1018
+
1019
+ - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+ </h3><div class="docstring">
1026
+ <div class="discussion">
1027
+
1028
+
1029
+ </div>
1030
+ </div>
1031
+ <div class="tags">
1032
+ <p class="tag_title">Parameters:</p>
1033
+ <ul class="param">
1034
+
1035
+ <li>
1036
+
1037
+ <span class='name'>params</span>
1038
+
1039
+
1040
+ <span class='type'>(<tt>Hash</tt>)</span>
1041
+
1042
+
1043
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
1044
+
1045
+
1046
+ &mdash;
1047
+ <div class='inline'>
1048
+ <p>a hash of params to be passed to the service</p>
1049
+ </div>
1050
+
1051
+ </li>
1052
+
1053
+ <li>
1054
+
1055
+ <span class='name'>headers</span>
1056
+
1057
+
1058
+ <span class='type'>(<tt>Hash</tt>)</span>
1059
+
1060
+
1061
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
1062
+
1063
+
1064
+ &mdash;
1065
+ <div class='inline'>
1066
+ <p>additional http headers</p>
1067
+ </div>
1068
+
1069
+ </li>
1070
+
1071
+ </ul>
1072
+
1073
+
1074
+
1075
+
1076
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
1077
+ <ul class="option">
1078
+
1079
+ <li>
1080
+ <span class="name">id</span>
1081
+ <span class="type">(<tt>String</tt>)</span>
1082
+ <span class="default">
1083
+
1084
+ </span>
1085
+
1086
+ </li>
1087
+
1088
+ <li>
1089
+ <span class="name">config_template</span>
1090
+ <span class="type">(<tt>Hash</tt>)</span>
1091
+ <span class="default">
1092
+
1093
+ </span>
1094
+
1095
+ &mdash; <div class='inline'>
1096
+ <p>allowed keys are:</p>
1097
+ <ul><li>
1098
+ <p>audit_comment [String, nil],</p>
1099
+ </li><li>
1100
+ <p>name [String] Template name ,</p>
1101
+ </li><li>
1102
+ <p>operatingsystem_ids [String] Array of operating systems id to associate the
1103
+ template with ,</p>
1104
+ </li><li>
1105
+ <p>snippet [String],</p>
1106
+ </li><li>
1107
+ <p>template [String],</p>
1108
+ </li><li>
1109
+ <p>template_combinations_attributes [String] Array of template combinations
1110
+ (hostgroupid, environmentid) ,</p>
1111
+ </li><li>
1112
+ <p>template_kind_id [String, nil] Not relevant for snippet ,</p>
1113
+ </li></ul>
1114
+ </div>
1115
+
1116
+ </li>
1117
+
1118
+ </ul>
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+ </div><table class="source_code">
1125
+ <tr>
1126
+ <td>
1127
+ <pre class="lines">
1128
+
1129
+
1130
+ 62
1131
+ 63
1132
+ 64
1133
+ 65
1134
+ 66</pre>
1135
+ </td>
1136
+ <td>
1137
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/config_template.rb', line 62</span>
1138
+
1139
+ <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>
1140
+ <span class='id identifier rubyid_check_params'>check_params</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='symbol'>:allowed</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:method</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid___method__'>__method__</span>
1141
+ <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_fill_params_in_url'>fill_params_in_url</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/config_templates/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
1142
+ <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:put</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</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>
1143
+ <span class='kw'>end</span></pre>
1144
+ </td>
1145
+ </tr>
1146
+ </table>
1147
+ </div>
1148
+
1149
+ </div>
1150
+
1151
+ </div>
1152
+
1153
+ <div id="footer">
1154
+ Generated on Mon Jan 21 15:44:36 2013 by
1155
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1156
+ 0.8.3 (ruby-1.9.3).
1157
+ </div>
1158
+
1159
+ </body>
1160
+ </html>