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/Subnet.html ADDED
@@ -0,0 +1,954 @@
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::Subnet
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 (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">Subnet</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::Subnet
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::Subnet</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/subnet.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="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</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
+ </ul>
261
+
262
+
263
+
264
+
265
+
266
+ <div id="class_method_details" class="method_details_list">
267
+ <h2>Class Method Details</h2>
268
+
269
+
270
+ <div class="method_details first">
271
+ <h3 class="signature first" id="doc-class_method">
272
+
273
+ + (<tt>Object</tt>) <strong>doc</strong>
274
+
275
+
276
+
277
+
278
+
279
+ </h3><table class="source_code">
280
+ <tr>
281
+ <td>
282
+ <pre class="lines">
283
+
284
+
285
+ 4
286
+ 5
287
+ 6</pre>
288
+ </td>
289
+ <td>
290
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 4</span>
291
+
292
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
293
+ <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'>subnets</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
294
+ <span class='kw'>end</span></pre>
295
+ </td>
296
+ </tr>
297
+ </table>
298
+ </div>
299
+
300
+ </div>
301
+
302
+ <div id="instance_method_details" class="method_details_list">
303
+ <h2>Instance Method Details</h2>
304
+
305
+
306
+ <div class="method_details first">
307
+ <h3 class="signature first" id="create-instance_method">
308
+
309
+ - (<tt>Object</tt>) <strong>create</strong>(params = { }, headers = { })
310
+
311
+
312
+
313
+
314
+
315
+ </h3><div class="docstring">
316
+ <div class="discussion">
317
+
318
+
319
+ </div>
320
+ </div>
321
+ <div class="tags">
322
+ <p class="tag_title">Parameters:</p>
323
+ <ul class="param">
324
+
325
+ <li>
326
+
327
+ <span class='name'>params</span>
328
+
329
+
330
+ <span class='type'>(<tt>Hash</tt>)</span>
331
+
332
+
333
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
334
+
335
+
336
+ &mdash;
337
+ <div class='inline'>
338
+ <p>a hash of params to be passed to the service</p>
339
+ </div>
340
+
341
+ </li>
342
+
343
+ <li>
344
+
345
+ <span class='name'>headers</span>
346
+
347
+
348
+ <span class='type'>(<tt>Hash</tt>)</span>
349
+
350
+
351
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
352
+
353
+
354
+ &mdash;
355
+ <div class='inline'>
356
+ <p>additional http headers</p>
357
+ </div>
358
+
359
+ </li>
360
+
361
+ </ul>
362
+
363
+
364
+
365
+
366
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
367
+ <ul class="option">
368
+
369
+ <li>
370
+ <span class="name">subnet</span>
371
+ <span class="type">(<tt>Hash</tt>)</span>
372
+ <span class="default">
373
+
374
+ </span>
375
+
376
+ &mdash; <div class='inline'>
377
+ <p>allowed keys are:</p>
378
+ <ul><li>
379
+ <p>dhcp_id [String] Dhcp proxy to use within this subnet ,</p>
380
+ </li><li>
381
+ <p>dns_id [String] Dns proxy to use within this subnet ,</p>
382
+ </li><li>
383
+ <p>dns_primary [String] Primary dns for this subnet ,</p>
384
+ </li><li>
385
+ <p>dns_secondary [String] Secondary dns for this subnet ,</p>
386
+ </li><li>
387
+ <p>domain_ids [String] Domains in which this subnet is part ,</p>
388
+ </li><li>
389
+ <p>from [String] Starting ip address for ip auto suggestion ,</p>
390
+ </li><li>
391
+ <p>gateway [String] Primary dns for this subnet ,</p>
392
+ </li><li>
393
+ <p>mask [String] Netmask for this subnet ,</p>
394
+ </li><li>
395
+ <p>name [String] Subnet name ,</p>
396
+ </li><li>
397
+ <p>network [String] Subnet network ,</p>
398
+ </li><li>
399
+ <p>tftp_id [String] Tftp proxy to use within this subnet ,</p>
400
+ </li><li>
401
+ <p>to [String] Ending ip address for ip auto suggestion ,</p>
402
+ </li><li>
403
+ <p>vlanid [String] Vlan id for this subnet ,</p>
404
+ </li></ul>
405
+ </div>
406
+
407
+ </li>
408
+
409
+ </ul>
410
+
411
+
412
+
413
+
414
+
415
+ </div><table class="source_code">
416
+ <tr>
417
+ <td>
418
+ <pre class="lines">
419
+
420
+
421
+ 49
422
+ 50
423
+ 51
424
+ 52
425
+ 53</pre>
426
+ </td>
427
+ <td>
428
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 49</span>
429
+
430
+ <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>
431
+ <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>
432
+ <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/subnets</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
433
+ <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>
434
+ <span class='kw'>end</span></pre>
435
+ </td>
436
+ </tr>
437
+ </table>
438
+ </div>
439
+
440
+ <div class="method_details ">
441
+ <h3 class="signature " id="destroy-instance_method">
442
+
443
+ - (<tt>Object</tt>) <strong>destroy</strong>(params = { }, headers = { })
444
+
445
+
446
+
447
+
448
+
449
+ </h3><div class="docstring">
450
+ <div class="discussion">
451
+
452
+
453
+ </div>
454
+ </div>
455
+ <div class="tags">
456
+ <p class="tag_title">Parameters:</p>
457
+ <ul class="param">
458
+
459
+ <li>
460
+
461
+ <span class='name'>params</span>
462
+
463
+
464
+ <span class='type'>(<tt>Hash</tt>)</span>
465
+
466
+
467
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
468
+
469
+
470
+ &mdash;
471
+ <div class='inline'>
472
+ <p>a hash of params to be passed to the service</p>
473
+ </div>
474
+
475
+ </li>
476
+
477
+ <li>
478
+
479
+ <span class='name'>headers</span>
480
+
481
+
482
+ <span class='type'>(<tt>Hash</tt>)</span>
483
+
484
+
485
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
486
+
487
+
488
+ &mdash;
489
+ <div class='inline'>
490
+ <p>additional http headers</p>
491
+ </div>
492
+
493
+ </li>
494
+
495
+ </ul>
496
+
497
+
498
+
499
+
500
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
501
+ <ul class="option">
502
+
503
+ <li>
504
+ <span class="name">id</span>
505
+ <span class="type">(<tt>String</tt>)</span>
506
+ <span class="default">
507
+
508
+ </span>
509
+
510
+ &mdash; <div class='inline'>
511
+ <p>Subnet numeric identifier</p>
512
+ </div>
513
+
514
+ </li>
515
+
516
+ </ul>
517
+
518
+
519
+
520
+
521
+
522
+ </div><table class="source_code">
523
+ <tr>
524
+ <td>
525
+ <pre class="lines">
526
+
527
+
528
+ 84
529
+ 85
530
+ 86
531
+ 87
532
+ 88</pre>
533
+ </td>
534
+ <td>
535
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 84</span>
536
+
537
+ <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>
538
+ <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>
539
+ <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/subnets/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
540
+ <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>
541
+ <span class='kw'>end</span></pre>
542
+ </td>
543
+ </tr>
544
+ </table>
545
+ </div>
546
+
547
+ <div class="method_details ">
548
+ <h3 class="signature " id="index-instance_method">
549
+
550
+ - (<tt>Object</tt>) <strong>index</strong>(params = { }, headers = { })
551
+
552
+
553
+
554
+
555
+
556
+ </h3><div class="docstring">
557
+ <div class="discussion">
558
+
559
+
560
+ </div>
561
+ </div>
562
+ <div class="tags">
563
+ <p class="tag_title">Parameters:</p>
564
+ <ul class="param">
565
+
566
+ <li>
567
+
568
+ <span class='name'>params</span>
569
+
570
+
571
+ <span class='type'>(<tt>Hash</tt>)</span>
572
+
573
+
574
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
575
+
576
+
577
+ &mdash;
578
+ <div class='inline'>
579
+ <p>a hash of params to be passed to the service</p>
580
+ </div>
581
+
582
+ </li>
583
+
584
+ <li>
585
+
586
+ <span class='name'>headers</span>
587
+
588
+
589
+ <span class='type'>(<tt>Hash</tt>)</span>
590
+
591
+
592
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
593
+
594
+
595
+ &mdash;
596
+ <div class='inline'>
597
+ <p>additional http headers</p>
598
+ </div>
599
+
600
+ </li>
601
+
602
+ </ul>
603
+
604
+
605
+
606
+
607
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
608
+ <ul class="option">
609
+
610
+ <li>
611
+ <span class="name">order</span>
612
+ <span class="type">(<tt>String</tt>)</span>
613
+ <span class="default">
614
+
615
+ </span>
616
+
617
+ &mdash; <div class='inline'>
618
+ <p>Sort results</p>
619
+ </div>
620
+
621
+ </li>
622
+
623
+ <li>
624
+ <span class="name">page</span>
625
+ <span class="type">(<tt>String</tt>)</span>
626
+ <span class="default">
627
+
628
+ </span>
629
+
630
+ &mdash; <div class='inline'>
631
+ <p>Paginate results</p>
632
+ </div>
633
+
634
+ </li>
635
+
636
+ <li>
637
+ <span class="name">per_page</span>
638
+ <span class="type">(<tt>String</tt>)</span>
639
+ <span class="default">
640
+
641
+ </span>
642
+
643
+ &mdash; <div class='inline'>
644
+ <p>Number of entries per request</p>
645
+ </div>
646
+
647
+ </li>
648
+
649
+ <li>
650
+ <span class="name">search</span>
651
+ <span class="type">(<tt>String</tt>)</span>
652
+ <span class="default">
653
+
654
+ </span>
655
+
656
+ &mdash; <div class='inline'>
657
+ <p>Filter results</p>
658
+ </div>
659
+
660
+ </li>
661
+
662
+ </ul>
663
+
664
+
665
+
666
+
667
+
668
+ </div><table class="source_code">
669
+ <tr>
670
+ <td>
671
+ <pre class="lines">
672
+
673
+
674
+ 15
675
+ 16
676
+ 17
677
+ 18
678
+ 19</pre>
679
+ </td>
680
+ <td>
681
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 15</span>
682
+
683
+ <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>
684
+ <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>
685
+ <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/subnets</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
686
+ <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>
687
+ <span class='kw'>end</span></pre>
688
+ </td>
689
+ </tr>
690
+ </table>
691
+ </div>
692
+
693
+ <div class="method_details ">
694
+ <h3 class="signature " id="show-instance_method">
695
+
696
+ - (<tt>Object</tt>) <strong>show</strong>(params = { }, headers = { })
697
+
698
+
699
+
700
+
701
+
702
+ </h3><div class="docstring">
703
+ <div class="discussion">
704
+
705
+
706
+ </div>
707
+ </div>
708
+ <div class="tags">
709
+ <p class="tag_title">Parameters:</p>
710
+ <ul class="param">
711
+
712
+ <li>
713
+
714
+ <span class='name'>params</span>
715
+
716
+
717
+ <span class='type'>(<tt>Hash</tt>)</span>
718
+
719
+
720
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
721
+
722
+
723
+ &mdash;
724
+ <div class='inline'>
725
+ <p>a hash of params to be passed to the service</p>
726
+ </div>
727
+
728
+ </li>
729
+
730
+ <li>
731
+
732
+ <span class='name'>headers</span>
733
+
734
+
735
+ <span class='type'>(<tt>Hash</tt>)</span>
736
+
737
+
738
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
739
+
740
+
741
+ &mdash;
742
+ <div class='inline'>
743
+ <p>additional http headers</p>
744
+ </div>
745
+
746
+ </li>
747
+
748
+ </ul>
749
+
750
+
751
+
752
+
753
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
754
+ <ul class="option">
755
+
756
+ <li>
757
+ <span class="name">id</span>
758
+ <span class="type">(<tt>String</tt>)</span>
759
+ <span class="default">
760
+
761
+ </span>
762
+
763
+ </li>
764
+
765
+ </ul>
766
+
767
+
768
+
769
+
770
+
771
+ </div><table class="source_code">
772
+ <tr>
773
+ <td>
774
+ <pre class="lines">
775
+
776
+
777
+ 25
778
+ 26
779
+ 27
780
+ 28
781
+ 29</pre>
782
+ </td>
783
+ <td>
784
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 25</span>
785
+
786
+ <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>
787
+ <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>
788
+ <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/subnets/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
789
+ <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>
790
+ <span class='kw'>end</span></pre>
791
+ </td>
792
+ </tr>
793
+ </table>
794
+ </div>
795
+
796
+ <div class="method_details ">
797
+ <h3 class="signature " id="update-instance_method">
798
+
799
+ - (<tt>Object</tt>) <strong>update</strong>(params = { }, headers = { })
800
+
801
+
802
+
803
+
804
+
805
+ </h3><div class="docstring">
806
+ <div class="discussion">
807
+
808
+
809
+ </div>
810
+ </div>
811
+ <div class="tags">
812
+ <p class="tag_title">Parameters:</p>
813
+ <ul class="param">
814
+
815
+ <li>
816
+
817
+ <span class='name'>params</span>
818
+
819
+
820
+ <span class='type'>(<tt>Hash</tt>)</span>
821
+
822
+
823
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
824
+
825
+
826
+ &mdash;
827
+ <div class='inline'>
828
+ <p>a hash of params to be passed to the service</p>
829
+ </div>
830
+
831
+ </li>
832
+
833
+ <li>
834
+
835
+ <span class='name'>headers</span>
836
+
837
+
838
+ <span class='type'>(<tt>Hash</tt>)</span>
839
+
840
+
841
+ <em class="default">(defaults to: <tt>{ }</tt>)</em>
842
+
843
+
844
+ &mdash;
845
+ <div class='inline'>
846
+ <p>additional http headers</p>
847
+ </div>
848
+
849
+ </li>
850
+
851
+ </ul>
852
+
853
+
854
+
855
+
856
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
857
+ <ul class="option">
858
+
859
+ <li>
860
+ <span class="name">id</span>
861
+ <span class="type">(<tt>String</tt>)</span>
862
+ <span class="default">
863
+
864
+ </span>
865
+
866
+ &mdash; <div class='inline'>
867
+ <p>Subnet numeric identifier</p>
868
+ </div>
869
+
870
+ </li>
871
+
872
+ <li>
873
+ <span class="name">subnet</span>
874
+ <span class="type">(<tt>Hash</tt>)</span>
875
+ <span class="default">
876
+
877
+ </span>
878
+
879
+ &mdash; <div class='inline'>
880
+ <p>allowed keys are:</p>
881
+ <ul><li>
882
+ <p>dhcp_id [String, nil] Dhcp proxy to use within this subnet ,</p>
883
+ </li><li>
884
+ <p>dns_id [String, nil] Dns proxy to use within this subnet ,</p>
885
+ </li><li>
886
+ <p>dns_primary [String, nil] Primary dns for this subnet ,</p>
887
+ </li><li>
888
+ <p>dns_secondary [String, nil] Secondary dns for this subnet ,</p>
889
+ </li><li>
890
+ <p>domain_ids [String, nil] Domains in which this subnet is part ,</p>
891
+ </li><li>
892
+ <p>from [String, nil] Starting ip address for ip auto suggestion ,</p>
893
+ </li><li>
894
+ <p>gateway [String, nil] Primary dns for this subnet ,</p>
895
+ </li><li>
896
+ <p>mask [String] Netmask for this subnet ,</p>
897
+ </li><li>
898
+ <p>name [String] Subnet name ,</p>
899
+ </li><li>
900
+ <p>network [String] Subnet network ,</p>
901
+ </li><li>
902
+ <p>tftp_id [String, nil] Tftp proxy to use within this subnet ,</p>
903
+ </li><li>
904
+ <p>to [String, nil] Ending ip address for ip auto suggestion ,</p>
905
+ </li><li>
906
+ <p>vlanid [String, nil] Vlan id for this subnet ,</p>
907
+ </li></ul>
908
+ </div>
909
+
910
+ </li>
911
+
912
+ </ul>
913
+
914
+
915
+
916
+
917
+
918
+ </div><table class="source_code">
919
+ <tr>
920
+ <td>
921
+ <pre class="lines">
922
+
923
+
924
+ 74
925
+ 75
926
+ 76
927
+ 77
928
+ 78</pre>
929
+ </td>
930
+ <td>
931
+ <pre class="code"><span class="info file"># File 'lib/foreman_api/resources/subnet.rb', line 74</span>
932
+
933
+ <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>
934
+ <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>
935
+ <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/subnets/:id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span>
936
+ <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>
937
+ <span class='kw'>end</span></pre>
938
+ </td>
939
+ </tr>
940
+ </table>
941
+ </div>
942
+
943
+ </div>
944
+
945
+ </div>
946
+
947
+ <div id="footer">
948
+ Generated on Mon Jan 21 15:44:35 2013 by
949
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
950
+ 0.8.3 (ruby-1.9.3).
951
+ </div>
952
+
953
+ </body>
954
+ </html>