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/Host.html ADDED
@@ -0,0 +1,1091 @@
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::Host
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 (H)</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">Host</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::Host
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::Host</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/host.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="#create-instance_method" title="#create (instance method)">- (Object) <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'></div></span>
168
+
169
+ </li>
170
+
171
+
172
+ <li class="public ">
173
+ <span class="summary_signature">
174
+
175
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</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="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</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="#show-instance_method" title="#show (instance method)">- (Object) <strong>show</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="#status-instance_method" title="#status (instance method)">- (Object) <strong>status</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="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</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
+ </ul>
283
+
284
+
285
+
286
+
287
+
288
+ <div id="class_method_details" class="method_details_list">
289
+ <h2>Class Method Details</h2>
290
+
291
+
292
+ <div class="method_details first">
293
+ <h3 class="signature first" id="doc-class_method">
294
+
295
+ + (<tt>Object</tt>) <strong>doc</strong>
296
+
297
+
298
+
299
+
300
+
301
+ </h3><table class="source_code">
302
+ <tr>
303
+ <td>
304
+ <pre class="lines">
305
+
306
+
307
+ 4
308
+ 5
309
+ 6</pre>
310
+ </td>
311
+ <td>
312
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 4</span>
313
+
314
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
315
+ <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'>hosts</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
316
+ <span class='kw'>end</span></pre>
317
+ </td>
318
+ </tr>
319
+ </table>
320
+ </div>
321
+
322
+ </div>
323
+
324
+ <div id="instance_method_details" class="method_details_list">
325
+ <h2>Instance Method Details</h2>
326
+
327
+
328
+ <div class="method_details first">
329
+ <h3 class="signature first" id="create-instance_method">
330
+
331
+ - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
332
+
333
+
334
+
335
+
336
+
337
+ </h3><div class="docstring">
338
+ <div class="discussion">
339
+
340
+
341
+ </div>
342
+ </div>
343
+ <div class="tags">
344
+ <p class="tag_title">Parameters:</p>
345
+ <ul class="param">
346
+
347
+ <li>
348
+
349
+ <span class='name'>params</span>
350
+
351
+
352
+ <span class='type'>(<tt>Hash</tt>)</span>
353
+
354
+
355
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
356
+
357
+
358
+ &mdash;
359
+ <div class='inline'>
360
+ <p>a hash of params to be passed to the service</p>
361
+ </div>
362
+
363
+ </li>
364
+
365
+ <li>
366
+
367
+ <span class='name'>headers</span>
368
+
369
+
370
+ <span class='type'>(<tt>Hash</tt>)</span>
371
+
372
+
373
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
374
+
375
+
376
+ &mdash;
377
+ <div class='inline'>
378
+ <p>additional http headers</p>
379
+ </div>
380
+
381
+ </li>
382
+
383
+ </ul>
384
+
385
+
386
+
387
+
388
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
389
+ <ul class="option">
390
+
391
+ <li>
392
+ <span class="name">host</span>
393
+ <span class="type">(<tt>Hash</tt>)</span>
394
+ <span class="default">
395
+
396
+ </span>
397
+
398
+ &mdash; <div class='inline'>
399
+ <p>allowed keys are:</p>
400
+ <ul><li>
401
+ <p>architecture_id [String],</p>
402
+ </li><li>
403
+ <p>domain_id [String],</p>
404
+ </li><li>
405
+ <p>environment_id [String],</p>
406
+ </li><li>
407
+ <p>host_parameters_attributes [String],</p>
408
+ </li><li>
409
+ <p>hostgroup_id [String],</p>
410
+ </li><li>
411
+ <p>image_id [String],</p>
412
+ </li><li>
413
+ <p>ip [String] Not required if using a subnet with dhcp proxy ,</p>
414
+ </li><li>
415
+ <p>mac [String] Not required if its a virtual machine ,</p>
416
+ </li><li>
417
+ <p>medium_id [String],</p>
418
+ </li><li>
419
+ <p>model_id_id [String],</p>
420
+ </li><li>
421
+ <p>name [String],</p>
422
+ </li><li>
423
+ <p>operatingsystem_id [String],</p>
424
+ </li><li>
425
+ <p>owner_id [String],</p>
426
+ </li><li>
427
+ <p>ptable_id [String],</p>
428
+ </li><li>
429
+ <p>puppet_ca_proxy_id [String],</p>
430
+ </li><li>
431
+ <p>puppet_proxy_id [String],</p>
432
+ </li><li>
433
+ <p>sp_subnet_id [String],</p>
434
+ </li><li>
435
+ <p>subnet_id [String],</p>
436
+ </li></ul>
437
+ </div>
438
+
439
+ </li>
440
+
441
+ </ul>
442
+
443
+
444
+
445
+
446
+
447
+ </div><table class="source_code">
448
+ <tr>
449
+ <td>
450
+ <pre class="lines">
451
+
452
+
453
+ 54
454
+ 55
455
+ 56
456
+ 57
457
+ 58</pre>
458
+ </td>
459
+ <td>
460
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 54</span>
461
+
462
+ <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>
463
+ <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>
464
+ <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/hosts</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
465
+ <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>
466
+ <span class='kw'>end</span></pre>
467
+ </td>
468
+ </tr>
469
+ </table>
470
+ </div>
471
+
472
+ <div class="method_details ">
473
+ <h3 class="signature " id="destroy-instance_method">
474
+
475
+ - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
476
+
477
+
478
+
479
+
480
+
481
+ </h3><div class="docstring">
482
+ <div class="discussion">
483
+
484
+
485
+ </div>
486
+ </div>
487
+ <div class="tags">
488
+ <p class="tag_title">Parameters:</p>
489
+ <ul class="param">
490
+
491
+ <li>
492
+
493
+ <span class='name'>params</span>
494
+
495
+
496
+ <span class='type'>(<tt>Hash</tt>)</span>
497
+
498
+
499
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
500
+
501
+
502
+ &mdash;
503
+ <div class='inline'>
504
+ <p>a hash of params to be passed to the service</p>
505
+ </div>
506
+
507
+ </li>
508
+
509
+ <li>
510
+
511
+ <span class='name'>headers</span>
512
+
513
+
514
+ <span class='type'>(<tt>Hash</tt>)</span>
515
+
516
+
517
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
518
+
519
+
520
+ &mdash;
521
+ <div class='inline'>
522
+ <p>additional http headers</p>
523
+ </div>
524
+
525
+ </li>
526
+
527
+ </ul>
528
+
529
+
530
+
531
+
532
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
533
+ <ul class="option">
534
+
535
+ <li>
536
+ <span class="name">id</span>
537
+ <span class="type">(<tt>String</tt>)</span>
538
+ <span class="default">
539
+
540
+ </span>
541
+
542
+ </li>
543
+
544
+ </ul>
545
+
546
+
547
+
548
+
549
+
550
+ </div><table class="source_code">
551
+ <tr>
552
+ <td>
553
+ <pre class="lines">
554
+
555
+
556
+ 94
557
+ 95
558
+ 96
559
+ 97
560
+ 98</pre>
561
+ </td>
562
+ <td>
563
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 94</span>
564
+
565
+ <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>
566
+ <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>
567
+ <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/hosts/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
568
+ <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>
569
+ <span class='kw'>end</span></pre>
570
+ </td>
571
+ </tr>
572
+ </table>
573
+ </div>
574
+
575
+ <div class="method_details ">
576
+ <h3 class="signature " id="index-instance_method">
577
+
578
+ - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
579
+
580
+
581
+
582
+
583
+
584
+ </h3><div class="docstring">
585
+ <div class="discussion">
586
+
587
+
588
+ </div>
589
+ </div>
590
+ <div class="tags">
591
+ <p class="tag_title">Parameters:</p>
592
+ <ul class="param">
593
+
594
+ <li>
595
+
596
+ <span class='name'>params</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>a hash of params to be passed to the service</p>
608
+ </div>
609
+
610
+ </li>
611
+
612
+ <li>
613
+
614
+ <span class='name'>headers</span>
615
+
616
+
617
+ <span class='type'>(<tt>Hash</tt>)</span>
618
+
619
+
620
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
621
+
622
+
623
+ &mdash;
624
+ <div class='inline'>
625
+ <p>additional http headers</p>
626
+ </div>
627
+
628
+ </li>
629
+
630
+ </ul>
631
+
632
+
633
+
634
+
635
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
636
+ <ul class="option">
637
+
638
+ <li>
639
+ <span class="name">order</span>
640
+ <span class="type">(<tt>String</tt>)</span>
641
+ <span class="default">
642
+
643
+ </span>
644
+
645
+ &mdash; <div class='inline'>
646
+ <p>Sort results</p>
647
+ </div>
648
+
649
+ </li>
650
+
651
+ <li>
652
+ <span class="name">page</span>
653
+ <span class="type">(<tt>String</tt>)</span>
654
+ <span class="default">
655
+
656
+ </span>
657
+
658
+ &mdash; <div class='inline'>
659
+ <p>Paginate results</p>
660
+ </div>
661
+
662
+ </li>
663
+
664
+ <li>
665
+ <span class="name">per_page</span>
666
+ <span class="type">(<tt>String</tt>)</span>
667
+ <span class="default">
668
+
669
+ </span>
670
+
671
+ &mdash; <div class='inline'>
672
+ <p>Number of entries per request</p>
673
+ </div>
674
+
675
+ </li>
676
+
677
+ <li>
678
+ <span class="name">search</span>
679
+ <span class="type">(<tt>String</tt>)</span>
680
+ <span class="default">
681
+
682
+ </span>
683
+
684
+ &mdash; <div class='inline'>
685
+ <p>Filter results</p>
686
+ </div>
687
+
688
+ </li>
689
+
690
+ </ul>
691
+
692
+
693
+
694
+
695
+
696
+ </div><table class="source_code">
697
+ <tr>
698
+ <td>
699
+ <pre class="lines">
700
+
701
+
702
+ 15
703
+ 16
704
+ 17
705
+ 18
706
+ 19</pre>
707
+ </td>
708
+ <td>
709
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 15</span>
710
+
711
+ <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>
712
+ <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>
713
+ <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/hosts</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
714
+ <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>
715
+ <span class='kw'>end</span></pre>
716
+ </td>
717
+ </tr>
718
+ </table>
719
+ </div>
720
+
721
+ <div class="method_details ">
722
+ <h3 class="signature " id="show-instance_method">
723
+
724
+ - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
725
+
726
+
727
+
728
+
729
+
730
+ </h3><div class="docstring">
731
+ <div class="discussion">
732
+
733
+
734
+ </div>
735
+ </div>
736
+ <div class="tags">
737
+ <p class="tag_title">Parameters:</p>
738
+ <ul class="param">
739
+
740
+ <li>
741
+
742
+ <span class='name'>params</span>
743
+
744
+
745
+ <span class='type'>(<tt>Hash</tt>)</span>
746
+
747
+
748
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
749
+
750
+
751
+ &mdash;
752
+ <div class='inline'>
753
+ <p>a hash of params to be passed to the service</p>
754
+ </div>
755
+
756
+ </li>
757
+
758
+ <li>
759
+
760
+ <span class='name'>headers</span>
761
+
762
+
763
+ <span class='type'>(<tt>Hash</tt>)</span>
764
+
765
+
766
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
767
+
768
+
769
+ &mdash;
770
+ <div class='inline'>
771
+ <p>additional http headers</p>
772
+ </div>
773
+
774
+ </li>
775
+
776
+ </ul>
777
+
778
+
779
+
780
+
781
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
782
+ <ul class="option">
783
+
784
+ <li>
785
+ <span class="name">id</span>
786
+ <span class="type">(<tt>String</tt>)</span>
787
+ <span class="default">
788
+
789
+ </span>
790
+
791
+ </li>
792
+
793
+ </ul>
794
+
795
+
796
+
797
+
798
+
799
+ </div><table class="source_code">
800
+ <tr>
801
+ <td>
802
+ <pre class="lines">
803
+
804
+
805
+ 25
806
+ 26
807
+ 27
808
+ 28
809
+ 29</pre>
810
+ </td>
811
+ <td>
812
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 25</span>
813
+
814
+ <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>
815
+ <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>
816
+ <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/hosts/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
817
+ <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>
818
+ <span class='kw'>end</span></pre>
819
+ </td>
820
+ </tr>
821
+ </table>
822
+ </div>
823
+
824
+ <div class="method_details ">
825
+ <h3 class="signature " id="status-instance_method">
826
+
827
+ - (<tt>Object</tt>) <strong>status</strong>(params = { }, headers = { })
828
+
829
+
830
+
831
+
832
+
833
+ </h3><div class="docstring">
834
+ <div class="discussion">
835
+
836
+
837
+ </div>
838
+ </div>
839
+ <div class="tags">
840
+ <p class="tag_title">Parameters:</p>
841
+ <ul class="param">
842
+
843
+ <li>
844
+
845
+ <span class='name'>params</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>a hash of params to be passed to the service</p>
857
+ </div>
858
+
859
+ </li>
860
+
861
+ <li>
862
+
863
+ <span class='name'>headers</span>
864
+
865
+
866
+ <span class='type'>(<tt>Hash</tt>)</span>
867
+
868
+
869
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
870
+
871
+
872
+ &mdash;
873
+ <div class='inline'>
874
+ <p>additional http headers</p>
875
+ </div>
876
+
877
+ </li>
878
+
879
+ </ul>
880
+
881
+
882
+
883
+
884
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
885
+ <ul class="option">
886
+
887
+ <li>
888
+ <span class="name">id</span>
889
+ <span class="type">(<tt>String</tt>)</span>
890
+ <span class="default">
891
+
892
+ </span>
893
+
894
+ </li>
895
+
896
+ </ul>
897
+
898
+
899
+
900
+
901
+
902
+ </div><table class="source_code">
903
+ <tr>
904
+ <td>
905
+ <pre class="lines">
906
+
907
+
908
+ 104
909
+ 105
910
+ 106
911
+ 107
912
+ 108</pre>
913
+ </td>
914
+ <td>
915
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 104</span>
916
+
917
+ <span class='kw'>def</span> <span class='id identifier rubyid_status'>status</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>
918
+ <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>
919
+ <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/hosts/:id/status</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
920
+ <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>
921
+ <span class='kw'>end</span></pre>
922
+ </td>
923
+ </tr>
924
+ </table>
925
+ </div>
926
+
927
+ <div class="method_details ">
928
+ <h3 class="signature " id="update-instance_method">
929
+
930
+ - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
931
+
932
+
933
+
934
+
935
+
936
+ </h3><div class="docstring">
937
+ <div class="discussion">
938
+
939
+
940
+ </div>
941
+ </div>
942
+ <div class="tags">
943
+ <p class="tag_title">Parameters:</p>
944
+ <ul class="param">
945
+
946
+ <li>
947
+
948
+ <span class='name'>params</span>
949
+
950
+
951
+ <span class='type'>(<tt>Hash</tt>)</span>
952
+
953
+
954
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
955
+
956
+
957
+ &mdash;
958
+ <div class='inline'>
959
+ <p>a hash of params to be passed to the service</p>
960
+ </div>
961
+
962
+ </li>
963
+
964
+ <li>
965
+
966
+ <span class='name'>headers</span>
967
+
968
+
969
+ <span class='type'>(<tt>Hash</tt>)</span>
970
+
971
+
972
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
973
+
974
+
975
+ &mdash;
976
+ <div class='inline'>
977
+ <p>additional http headers</p>
978
+ </div>
979
+
980
+ </li>
981
+
982
+ </ul>
983
+
984
+
985
+
986
+
987
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
988
+ <ul class="option">
989
+
990
+ <li>
991
+ <span class="name">id</span>
992
+ <span class="type">(<tt>String</tt>)</span>
993
+ <span class="default">
994
+
995
+ </span>
996
+
997
+ </li>
998
+
999
+ <li>
1000
+ <span class="name">host</span>
1001
+ <span class="type">(<tt>Hash</tt>)</span>
1002
+ <span class="default">
1003
+
1004
+ </span>
1005
+
1006
+ &mdash; <div class='inline'>
1007
+ <p>allowed keys are:</p>
1008
+ <ul><li>
1009
+ <p>architecture_id [String],</p>
1010
+ </li><li>
1011
+ <p>domain_id [String],</p>
1012
+ </li><li>
1013
+ <p>environment_id [String],</p>
1014
+ </li><li>
1015
+ <p>host_parameters_attributes [String],</p>
1016
+ </li><li>
1017
+ <p>hostgroup_id [String],</p>
1018
+ </li><li>
1019
+ <p>image_id [String],</p>
1020
+ </li><li>
1021
+ <p>ip [String] Not required if using a subnet with dhcp proxy ,</p>
1022
+ </li><li>
1023
+ <p>mac [String] Not required if its a virtual machine ,</p>
1024
+ </li><li>
1025
+ <p>medium_id [String],</p>
1026
+ </li><li>
1027
+ <p>model_id_id [String],</p>
1028
+ </li><li>
1029
+ <p>name [String],</p>
1030
+ </li><li>
1031
+ <p>operatingsystem_id [String],</p>
1032
+ </li><li>
1033
+ <p>owner_id [String],</p>
1034
+ </li><li>
1035
+ <p>ptable_id [String],</p>
1036
+ </li><li>
1037
+ <p>puppet_ca_proxy_id [String],</p>
1038
+ </li><li>
1039
+ <p>puppet_proxy_id [String],</p>
1040
+ </li><li>
1041
+ <p>sp_subnet_id [String],</p>
1042
+ </li><li>
1043
+ <p>subnet_id [String],</p>
1044
+ </li></ul>
1045
+ </div>
1046
+
1047
+ </li>
1048
+
1049
+ </ul>
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+ </div><table class="source_code">
1056
+ <tr>
1057
+ <td>
1058
+ <pre class="lines">
1059
+
1060
+
1061
+ 84
1062
+ 85
1063
+ 86
1064
+ 87
1065
+ 88</pre>
1066
+ </td>
1067
+ <td>
1068
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 84</span>
1069
+
1070
+ <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>
1071
+ <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>
1072
+ <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/hosts/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
1073
+ <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>
1074
+ <span class='kw'>end</span></pre>
1075
+ </td>
1076
+ </tr>
1077
+ </table>
1078
+ </div>
1079
+
1080
+ </div>
1081
+
1082
+ </div>
1083
+
1084
+ <div id="footer">
1085
+ Generated on Mon Jan 21 15:44:34 2013 by
1086
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1087
+ 0.8.3 (ruby-1.9.3).
1088
+ </div>
1089
+
1090
+ </body>
1091
+ </html>