katello_api 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. data/.gitignore +2 -0
  2. data/Gemfile +2 -0
  3. data/README.rdoc +0 -4
  4. data/doc/KatelloApi/Base.html +831 -0
  5. data/doc/KatelloApi/Generator/Base.html +671 -0
  6. data/doc/KatelloApi/Generator.html +115 -0
  7. data/doc/KatelloApi/Resources/ActivationKey.html +1757 -0
  8. data/doc/KatelloApi/Resources/Architecture.html +1007 -0
  9. data/doc/KatelloApi/Resources/Changeset.html +1413 -0
  10. data/doc/KatelloApi/Resources/ChangesetsContent.html +2674 -0
  11. data/doc/KatelloApi/Resources/ComputeResource.html +1067 -0
  12. data/doc/KatelloApi/Resources/ConfigTemplate.html +1361 -0
  13. data/doc/KatelloApi/Resources/ContentView.html +938 -0
  14. data/doc/KatelloApi/Resources/ContentViewDefinition.html +1629 -0
  15. data/doc/KatelloApi/Resources/Crl.html +367 -0
  16. data/doc/KatelloApi/Resources/Distribution.html +560 -0
  17. data/doc/KatelloApi/Resources/Distributor.html +1892 -0
  18. data/doc/KatelloApi/Resources/Domain.html +1066 -0
  19. data/doc/KatelloApi/Resources/Environment.html +1645 -0
  20. data/doc/KatelloApi/Resources/Erratum.html +632 -0
  21. data/doc/KatelloApi/Resources/GpgKey.html +1220 -0
  22. data/doc/KatelloApi/Resources/HardwareModel.html +1025 -0
  23. data/doc/KatelloApi/Resources/Organization.html +1062 -0
  24. data/doc/KatelloApi/Resources/Package.html +728 -0
  25. data/doc/KatelloApi/Resources/Permission.html +1021 -0
  26. data/doc/KatelloApi/Resources/Ping.html +625 -0
  27. data/doc/KatelloApi/Resources/Product.html +1845 -0
  28. data/doc/KatelloApi/Resources/Provider.html +2237 -0
  29. data/doc/KatelloApi/Resources/Repository.html +1976 -0
  30. data/doc/KatelloApi/Resources/RepositorySet.html +770 -0
  31. data/doc/KatelloApi/Resources/Role.html +1257 -0
  32. data/doc/KatelloApi/Resources/RoleLdapGroup.html +728 -0
  33. data/doc/KatelloApi/Resources/SmartProxy.html +1054 -0
  34. data/doc/KatelloApi/Resources/Statu.html +367 -0
  35. data/doc/KatelloApi/Resources/Subnet.html +1007 -0
  36. data/doc/KatelloApi/Resources/Subscription.html +1064 -0
  37. data/doc/KatelloApi/Resources/Sync.html +826 -0
  38. data/doc/KatelloApi/Resources/SyncPlan.html +1148 -0
  39. data/doc/KatelloApi/Resources/System.html +3576 -0
  40. data/doc/KatelloApi/Resources/SystemGroup.html +2006 -0
  41. data/doc/KatelloApi/Resources/SystemGroupErratum.html +602 -0
  42. data/doc/KatelloApi/Resources/SystemGroupPackage.html +826 -0
  43. data/doc/KatelloApi/Resources/SystemPackage.html +770 -0
  44. data/doc/KatelloApi/Resources/Task.html +546 -0
  45. data/doc/KatelloApi/Resources/Template.html +1573 -0
  46. data/doc/KatelloApi/Resources/TemplatesContent.html +2268 -0
  47. data/doc/KatelloApi/Resources/Uebercert.html +406 -0
  48. data/doc/KatelloApi/Resources/User.html +1846 -0
  49. data/doc/KatelloApi/Resources.html +117 -0
  50. data/doc/KatelloApi.html +365 -0
  51. data/doc/_index.html +539 -0
  52. data/doc/class_list.html +53 -0
  53. data/doc/css/common.css +1 -0
  54. data/doc/css/full_list.css +57 -0
  55. data/doc/css/style.css +338 -0
  56. data/doc/file.README.html +127 -0
  57. data/doc/file_list.html +55 -0
  58. data/doc/frames.html +28 -0
  59. data/doc/index.html +127 -0
  60. data/doc/js/app.js +214 -0
  61. data/doc/js/full_list.js +173 -0
  62. data/doc/js/jquery.js +4 -0
  63. data/doc/method_list.html +2548 -0
  64. data/doc/top-level-namespace.html +112 -0
  65. data/lib/katello_api/base.rb +61 -6
  66. data/lib/katello_api/documentation.json +1 -0
  67. data/lib/katello_api/resources/activation_key.rb +51 -48
  68. data/lib/katello_api/resources/architecture.rb +19 -24
  69. data/lib/katello_api/resources/changeset.rb +39 -37
  70. data/lib/katello_api/resources/changesets_content.rb +64 -57
  71. data/lib/katello_api/resources/compute_resource.rb +37 -42
  72. data/lib/katello_api/resources/config_template.rb +40 -44
  73. data/lib/katello_api/resources/content_view.rb +14 -17
  74. data/lib/katello_api/resources/content_view_definition.rb +34 -42
  75. data/lib/katello_api/resources/crl.rb +3 -4
  76. data/lib/katello_api/resources/distribution.rb +8 -8
  77. data/lib/katello_api/resources/distributor.rb +35 -37
  78. data/lib/katello_api/resources/domain.rb +28 -32
  79. data/lib/katello_api/resources/environment.rb +38 -44
  80. data/lib/katello_api/resources/erratum.rb +9 -8
  81. data/lib/katello_api/resources/gpg_key.rb +28 -33
  82. data/lib/katello_api/resources/hardware_model.rb +25 -30
  83. data/lib/katello_api/resources/organization.rb +24 -26
  84. data/lib/katello_api/resources/package.rb +9 -12
  85. data/lib/katello_api/resources/permission.rb +21 -19
  86. data/lib/katello_api/resources/ping.rb +9 -12
  87. data/lib/katello_api/resources/product.rb +34 -43
  88. data/lib/katello_api/resources/provider.rb +55 -66
  89. data/lib/katello_api/resources/repository.rb +44 -55
  90. data/lib/katello_api/resources/repository_set.rb +9 -12
  91. data/lib/katello_api/resources/role.rb +35 -33
  92. data/lib/katello_api/resources/role_ldap_group.rb +10 -12
  93. data/lib/katello_api/resources/smart_proxy.rb +24 -28
  94. data/lib/katello_api/resources/statu.rb +3 -4
  95. data/lib/katello_api/resources/subnet.rb +19 -24
  96. data/lib/katello_api/resources/subscription.rb +16 -21
  97. data/lib/katello_api/resources/sync.rb +9 -12
  98. data/lib/katello_api/resources/sync_plan.rb +28 -33
  99. data/lib/katello_api/resources/system.rb +81 -90
  100. data/lib/katello_api/resources/system_group.rb +47 -57
  101. data/lib/katello_api/resources/system_group_erratum.rb +6 -8
  102. data/lib/katello_api/resources/system_group_package.rb +15 -18
  103. data/lib/katello_api/resources/system_package.rb +12 -15
  104. data/lib/katello_api/resources/task.rb +6 -8
  105. data/lib/katello_api/resources/template.rb +39 -47
  106. data/lib/katello_api/resources/templates_content.rb +40 -52
  107. data/lib/katello_api/resources/uebercert.rb +4 -4
  108. data/lib/katello_api/resources/user.rb +47 -50
  109. data/lib/katello_api/version.rb +1 -1
  110. data/lib/katello_api.rb +0 -13
  111. metadata +68 -4
@@ -0,0 +1,1067 @@
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: KatelloApi::Resources::ComputeResource
8
+
9
+ &mdash; Documentation by YARD 0.8.5.2
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="../../KatelloApi.html" title="KatelloApi (module)">KatelloApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resources.html" title="KatelloApi::Resources (module)">Resources</a></span></span>
36
+ &raquo;
37
+ <span class="title">ComputeResource</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: KatelloApi::Resources::ComputeResource
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"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></li>
82
+
83
+ <li class="next">KatelloApi::Resources::ComputeResource</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/katello_api/resources/compute_resource.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+ <h2>Constant Summary</h2>
106
+
107
+
108
+
109
+
110
+ <h2>Constant Summary</h2>
111
+
112
+ <h3 class="inherited">Constants inherited
113
+ from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
114
+ <p class="inherited"><span class='object_link'><a href="../Base.html#API_VERSION-constant" title="KatelloApi::Base::API_VERSION (constant)">Base::API_VERSION</a></span></p>
115
+
116
+
117
+
118
+
119
+ <h2>Instance Attribute Summary</h2>
120
+
121
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
122
+ <p class="inherited"><span class='object_link'><a href="../Base.html#client-instance_method" title="KatelloApi::Base#client (method)">#client</a></span>, <span class='object_link'><a href="../Base.html#config-instance_method" title="KatelloApi::Base#config (method)">#config</a></span></p>
123
+
124
+
125
+
126
+ <h2>
127
+ Class Method Summary
128
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
129
+ </h2>
130
+
131
+ <ul class="summary">
132
+
133
+ <li class="public ">
134
+ <span class="summary_signature">
135
+
136
+ <a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
137
+
138
+
139
+
140
+ </span>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'></div></span>
151
+
152
+ </li>
153
+
154
+
155
+ </ul>
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'><p>
182
+ First item: parsed data; second item: raw body.
183
+ </p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'><p>
207
+ First item: parsed data; second item: raw body.
208
+ </p>
209
+ </div></span>
210
+
211
+ </li>
212
+
213
+
214
+ <li class="public ">
215
+ <span class="summary_signature">
216
+
217
+ <a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
218
+
219
+
220
+
221
+ </span>
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <span class="summary_desc"><div class='inline'><p>
232
+ First item: parsed data; second item: raw body.
233
+ </p>
234
+ </div></span>
235
+
236
+ </li>
237
+
238
+
239
+ <li class="public ">
240
+ <span class="summary_signature">
241
+
242
+ <a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
243
+
244
+
245
+
246
+ </span>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+ <span class="summary_desc"><div class='inline'><p>
257
+ First item: parsed data; second item: raw body.
258
+ </p>
259
+ </div></span>
260
+
261
+ </li>
262
+
263
+
264
+ <li class="public ">
265
+ <span class="summary_signature">
266
+
267
+ <a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
268
+
269
+
270
+
271
+ </span>
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <span class="summary_desc"><div class='inline'><p>
282
+ First item: parsed data; second item: raw body.
283
+ </p>
284
+ </div></span>
285
+
286
+ </li>
287
+
288
+
289
+ </ul>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="KatelloApi::Base (class)">Base</a></span></h3>
302
+ <p class="inherited"><span class='object_link'><a href="../Base.html#http_call-instance_method" title="KatelloApi::Base#http_call (method)">#http_call</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Base.html#method_doc-class_method" title="KatelloApi::Base.method_doc (method)">method_doc</a></span>, <span class='object_link'><a href="../Base.html#perform_call-instance_method" title="KatelloApi::Base#perform_call (method)">#perform_call</a></span>, <span class='object_link'><a href="../Base.html#validate_params%21-instance_method" title="KatelloApi::Base#validate_params! (method)">#validate_params!</a></span>, <span class='object_link'><a href="../Base.html#validation_hash-class_method" title="KatelloApi::Base.validation_hash (method)">validation_hash</a></span></p>
303
+ <div id="constructor_details" class="method_details_list">
304
+ <h2>Constructor Details</h2>
305
+
306
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="KatelloApi::Base#initialize (method)">KatelloApi::Base</a></span></p>
307
+
308
+ </div>
309
+
310
+
311
+ <div id="class_method_details" class="method_details_list">
312
+ <h2>Class Method Details</h2>
313
+
314
+
315
+ <div class="method_details first">
316
+ <h3 class="signature first" id="doc-class_method">
317
+
318
+ + (<tt>Object</tt>) <strong>doc</strong>
319
+
320
+
321
+
322
+
323
+
324
+ </h3><table class="source_code">
325
+ <tr>
326
+ <td>
327
+ <pre class="lines">
328
+
329
+
330
+ 4
331
+ 5
332
+ 6</pre>
333
+ </td>
334
+ <td>
335
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/compute_resource.rb', line 4</span>
336
+
337
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span>
338
+ <span class='rubyid_@doc ivar id'>@doc</span> <span class='opasgn op'>||=</span> <span class='rubyid_KatelloApi constant id'>KatelloApi</span><span class='dot token'>.</span><span class='rubyid_doc identifier id'>doc</span><span class='lbrack token'>[</span><span class='string val'>'resources'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>&quot;compute_resources&quot;</span><span class='rbrack token'>]</span>
339
+ <span class='rubyid_end end kw'>end</span>
340
+ </pre>
341
+ </td>
342
+ </tr>
343
+ </table>
344
+ </div>
345
+
346
+ </div>
347
+
348
+ <div id="instance_method_details" class="method_details_list">
349
+ <h2>Instance Method Details</h2>
350
+
351
+
352
+ <div class="method_details first">
353
+ <h3 class="signature first" id="create-instance_method">
354
+
355
+ - (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
356
+
357
+
358
+
359
+
360
+
361
+ </h3><div class="docstring">
362
+ <div class="discussion">
363
+ <p>
364
+ First item: parsed data; second item: raw body
365
+ </p>
366
+
367
+
368
+ </div>
369
+ </div>
370
+ <div class="tags">
371
+ <p class="tag_title">Parameters:</p>
372
+ <ul class="param">
373
+
374
+ <li>
375
+
376
+ <span class='name'>params</span>
377
+
378
+
379
+ <span class='type'>(<tt>Hash</tt>)</span>
380
+
381
+
382
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
383
+
384
+
385
+ &mdash;
386
+ <div class='inline'><p>
387
+ a hash of params to be passed to the service
388
+ </p>
389
+ </div>
390
+
391
+ </li>
392
+
393
+ <li>
394
+
395
+ <span class='name'>headers</span>
396
+
397
+
398
+ <span class='type'>(<tt>Hash</tt>)</span>
399
+
400
+
401
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'><p>
406
+ additional http headers
407
+ </p>
408
+ </div>
409
+
410
+ </li>
411
+
412
+ </ul>
413
+
414
+
415
+
416
+
417
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
418
+ <ul class="option">
419
+
420
+ <li>
421
+ <span class="name">compute_resource</span>
422
+ <span class="type">(<tt>Hash</tt>)</span>
423
+ <span class="default">
424
+
425
+ </span>
426
+
427
+ &mdash; <div class='inline'><p>
428
+ compute resource info allowed keys are:
429
+ </p>
430
+ <ul>
431
+ <li>description [String, nil]
432
+
433
+ </li>
434
+ <li>name [String]
435
+
436
+ </li>
437
+ <li>password [String, nil] password for ovirt, ec2, vmware, openstack. secret
438
+ key for ec2
439
+
440
+ </li>
441
+ <li>provider [String] providers include libvirt, ovirt, ec2, vmware, openstack,
442
+ rackspace
443
+
444
+ </li>
445
+ <li>region [String, nil] for ec2 only
446
+
447
+ </li>
448
+ <li>server [String, nil] for vmware
449
+
450
+ </li>
451
+ <li>tenant [String, nil] for openstack only
452
+
453
+ </li>
454
+ <li>url [String] url for libvirt, ovirt, and openstack
455
+
456
+ </li>
457
+ <li>user [String, nil] username for ovirt, ec2, vmware, openstack. access key
458
+ for ec2.
459
+
460
+ </li>
461
+ <li>uuid [String, nil] for ovirt, vmware datacenter
462
+
463
+ </li>
464
+ </ul>
465
+ </div>
466
+
467
+ </li>
468
+
469
+ </ul>
470
+
471
+
472
+
473
+
474
+ <p class="tag_title">Returns:</p>
475
+ <ul class="return">
476
+
477
+ <li>
478
+
479
+
480
+ <span class='type'>(<tt>Array</tt>)</span>
481
+
482
+
483
+
484
+ &mdash;
485
+ <div class='inline'><p>
486
+ First item: parsed data; second item: raw body
487
+ </p>
488
+ </div>
489
+
490
+ </li>
491
+
492
+ </ul>
493
+
494
+ </div><table class="source_code">
495
+ <tr>
496
+ <td>
497
+ <pre class="lines">
498
+
499
+
500
+ 41
501
+ 42
502
+ 43</pre>
503
+ </td>
504
+ <td>
505
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/compute_resource.rb', line 41</span>
506
+
507
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_create identifier id'>create</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
508
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
509
+ <span class='rubyid_end end kw'>end</span>
510
+ </pre>
511
+ </td>
512
+ </tr>
513
+ </table>
514
+ </div>
515
+
516
+ <div class="method_details ">
517
+ <h3 class="signature " id="destroy-instance_method">
518
+
519
+ - (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
520
+
521
+
522
+
523
+
524
+
525
+ </h3><div class="docstring">
526
+ <div class="discussion">
527
+ <p>
528
+ First item: parsed data; second item: raw body
529
+ </p>
530
+
531
+
532
+ </div>
533
+ </div>
534
+ <div class="tags">
535
+ <p class="tag_title">Parameters:</p>
536
+ <ul class="param">
537
+
538
+ <li>
539
+
540
+ <span class='name'>params</span>
541
+
542
+
543
+ <span class='type'>(<tt>Hash</tt>)</span>
544
+
545
+
546
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
547
+
548
+
549
+ &mdash;
550
+ <div class='inline'><p>
551
+ a hash of params to be passed to the service
552
+ </p>
553
+ </div>
554
+
555
+ </li>
556
+
557
+ <li>
558
+
559
+ <span class='name'>headers</span>
560
+
561
+
562
+ <span class='type'>(<tt>Hash</tt>)</span>
563
+
564
+
565
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
566
+
567
+
568
+ &mdash;
569
+ <div class='inline'><p>
570
+ additional http headers
571
+ </p>
572
+ </div>
573
+
574
+ </li>
575
+
576
+ </ul>
577
+
578
+
579
+
580
+
581
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
582
+ <ul class="option">
583
+
584
+ <li>
585
+ <span class="name">id</span>
586
+ <span class="type">(<tt>String</tt>)</span>
587
+ <span class="default">
588
+
589
+ </span>
590
+
591
+ &mdash; <div class='inline'><p>
592
+ compute resource name
593
+ </p>
594
+ </div>
595
+
596
+ </li>
597
+
598
+ </ul>
599
+
600
+
601
+
602
+
603
+ <p class="tag_title">Returns:</p>
604
+ <ul class="return">
605
+
606
+ <li>
607
+
608
+
609
+ <span class='type'>(<tt>Array</tt>)</span>
610
+
611
+
612
+
613
+ &mdash;
614
+ <div class='inline'><p>
615
+ First item: parsed data; second item: raw body
616
+ </p>
617
+ </div>
618
+
619
+ </li>
620
+
621
+ </ul>
622
+
623
+ </div><table class="source_code">
624
+ <tr>
625
+ <td>
626
+ <pre class="lines">
627
+
628
+
629
+ 71
630
+ 72
631
+ 73</pre>
632
+ </td>
633
+ <td>
634
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/compute_resource.rb', line 71</span>
635
+
636
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_destroy identifier id'>destroy</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
637
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
638
+ <span class='rubyid_end end kw'>end</span>
639
+ </pre>
640
+ </td>
641
+ </tr>
642
+ </table>
643
+ </div>
644
+
645
+ <div class="method_details ">
646
+ <h3 class="signature " id="index-instance_method">
647
+
648
+ - (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
649
+
650
+
651
+
652
+
653
+
654
+ </h3><div class="docstring">
655
+ <div class="discussion">
656
+ <p>
657
+ First item: parsed data; second item: raw body
658
+ </p>
659
+
660
+
661
+ </div>
662
+ </div>
663
+ <div class="tags">
664
+ <p class="tag_title">Parameters:</p>
665
+ <ul class="param">
666
+
667
+ <li>
668
+
669
+ <span class='name'>params</span>
670
+
671
+
672
+ <span class='type'>(<tt>Hash</tt>)</span>
673
+
674
+
675
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
676
+
677
+
678
+ &mdash;
679
+ <div class='inline'><p>
680
+ a hash of params to be passed to the service
681
+ </p>
682
+ </div>
683
+
684
+ </li>
685
+
686
+ <li>
687
+
688
+ <span class='name'>headers</span>
689
+
690
+
691
+ <span class='type'>(<tt>Hash</tt>)</span>
692
+
693
+
694
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
695
+
696
+
697
+ &mdash;
698
+ <div class='inline'><p>
699
+ additional http headers
700
+ </p>
701
+ </div>
702
+
703
+ </li>
704
+
705
+ </ul>
706
+
707
+ <p class="tag_title">Returns:</p>
708
+ <ul class="return">
709
+
710
+ <li>
711
+
712
+
713
+ <span class='type'>(<tt>Array</tt>)</span>
714
+
715
+
716
+
717
+ &mdash;
718
+ <div class='inline'><p>
719
+ First item: parsed data; second item: raw body
720
+ </p>
721
+ </div>
722
+
723
+ </li>
724
+
725
+ </ul>
726
+
727
+ </div><table class="source_code">
728
+ <tr>
729
+ <td>
730
+ <pre class="lines">
731
+
732
+
733
+ 12
734
+ 13
735
+ 14</pre>
736
+ </td>
737
+ <td>
738
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/compute_resource.rb', line 12</span>
739
+
740
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_index identifier id'>index</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
741
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
742
+ <span class='rubyid_end end kw'>end</span>
743
+ </pre>
744
+ </td>
745
+ </tr>
746
+ </table>
747
+ </div>
748
+
749
+ <div class="method_details ">
750
+ <h3 class="signature " id="show-instance_method">
751
+
752
+ - (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
753
+
754
+
755
+
756
+
757
+
758
+ </h3><div class="docstring">
759
+ <div class="discussion">
760
+ <p>
761
+ First item: parsed data; second item: raw body
762
+ </p>
763
+
764
+
765
+ </div>
766
+ </div>
767
+ <div class="tags">
768
+ <p class="tag_title">Parameters:</p>
769
+ <ul class="param">
770
+
771
+ <li>
772
+
773
+ <span class='name'>params</span>
774
+
775
+
776
+ <span class='type'>(<tt>Hash</tt>)</span>
777
+
778
+
779
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
780
+
781
+
782
+ &mdash;
783
+ <div class='inline'><p>
784
+ a hash of params to be passed to the service
785
+ </p>
786
+ </div>
787
+
788
+ </li>
789
+
790
+ <li>
791
+
792
+ <span class='name'>headers</span>
793
+
794
+
795
+ <span class='type'>(<tt>Hash</tt>)</span>
796
+
797
+
798
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
799
+
800
+
801
+ &mdash;
802
+ <div class='inline'><p>
803
+ additional http headers
804
+ </p>
805
+ </div>
806
+
807
+ </li>
808
+
809
+ </ul>
810
+
811
+
812
+
813
+
814
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
815
+ <ul class="option">
816
+
817
+ <li>
818
+ <span class="name">id</span>
819
+ <span class="type">(<tt>String</tt>)</span>
820
+ <span class="default">
821
+
822
+ </span>
823
+
824
+ &mdash; <div class='inline'><p>
825
+ compute resource name
826
+ </p>
827
+ </div>
828
+
829
+ </li>
830
+
831
+ </ul>
832
+
833
+
834
+
835
+
836
+ <p class="tag_title">Returns:</p>
837
+ <ul class="return">
838
+
839
+ <li>
840
+
841
+
842
+ <span class='type'>(<tt>Array</tt>)</span>
843
+
844
+
845
+
846
+ &mdash;
847
+ <div class='inline'><p>
848
+ First item: parsed data; second item: raw body
849
+ </p>
850
+ </div>
851
+
852
+ </li>
853
+
854
+ </ul>
855
+
856
+ </div><table class="source_code">
857
+ <tr>
858
+ <td>
859
+ <pre class="lines">
860
+
861
+
862
+ 21
863
+ 22
864
+ 23</pre>
865
+ </td>
866
+ <td>
867
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/compute_resource.rb', line 21</span>
868
+
869
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_show identifier id'>show</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
870
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
871
+ <span class='rubyid_end end kw'>end</span>
872
+ </pre>
873
+ </td>
874
+ </tr>
875
+ </table>
876
+ </div>
877
+
878
+ <div class="method_details ">
879
+ <h3 class="signature " id="update-instance_method">
880
+
881
+ - (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
882
+
883
+
884
+
885
+
886
+
887
+ </h3><div class="docstring">
888
+ <div class="discussion">
889
+ <p>
890
+ First item: parsed data; second item: raw body
891
+ </p>
892
+
893
+
894
+ </div>
895
+ </div>
896
+ <div class="tags">
897
+ <p class="tag_title">Parameters:</p>
898
+ <ul class="param">
899
+
900
+ <li>
901
+
902
+ <span class='name'>params</span>
903
+
904
+
905
+ <span class='type'>(<tt>Hash</tt>)</span>
906
+
907
+
908
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
909
+
910
+
911
+ &mdash;
912
+ <div class='inline'><p>
913
+ a hash of params to be passed to the service
914
+ </p>
915
+ </div>
916
+
917
+ </li>
918
+
919
+ <li>
920
+
921
+ <span class='name'>headers</span>
922
+
923
+
924
+ <span class='type'>(<tt>Hash</tt>)</span>
925
+
926
+
927
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
928
+
929
+
930
+ &mdash;
931
+ <div class='inline'><p>
932
+ additional http headers
933
+ </p>
934
+ </div>
935
+
936
+ </li>
937
+
938
+ </ul>
939
+
940
+
941
+
942
+
943
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
944
+ <ul class="option">
945
+
946
+ <li>
947
+ <span class="name">id</span>
948
+ <span class="type">(<tt>String</tt>)</span>
949
+ <span class="default">
950
+
951
+ </span>
952
+
953
+ &mdash; <div class='inline'><p>
954
+ compute resource name
955
+ </p>
956
+ </div>
957
+
958
+ </li>
959
+
960
+ <li>
961
+ <span class="name">compute_resource</span>
962
+ <span class="type">(<tt>Hash</tt>)</span>
963
+ <span class="default">
964
+
965
+ </span>
966
+
967
+ &mdash; <div class='inline'><p>
968
+ compute resource info allowed keys are:
969
+ </p>
970
+ <ul>
971
+ <li>description [String, nil]
972
+
973
+ </li>
974
+ <li>name [String]
975
+
976
+ </li>
977
+ <li>password [String, nil] password for ovirt, ec2, vmware, openstack. secret
978
+ key for ec2
979
+
980
+ </li>
981
+ <li>provider [String] providers include libvirt, ovirt, ec2, vmware, openstack,
982
+ rackspace
983
+
984
+ </li>
985
+ <li>region [String, nil] for ec2 only
986
+
987
+ </li>
988
+ <li>server [String, nil] for vmware
989
+
990
+ </li>
991
+ <li>tenant [String, nil] for openstack only
992
+
993
+ </li>
994
+ <li>url [String] url for libvirt, ovirt, and openstack
995
+
996
+ </li>
997
+ <li>user [String, nil] username for ovirt, ec2, vmware, openstack. access key
998
+ for ec2.
999
+
1000
+ </li>
1001
+ <li>uuid [String, nil] for ovirt, vmware datacenter
1002
+
1003
+ </li>
1004
+ </ul>
1005
+ </div>
1006
+
1007
+ </li>
1008
+
1009
+ </ul>
1010
+
1011
+
1012
+
1013
+
1014
+ <p class="tag_title">Returns:</p>
1015
+ <ul class="return">
1016
+
1017
+ <li>
1018
+
1019
+
1020
+ <span class='type'>(<tt>Array</tt>)</span>
1021
+
1022
+
1023
+
1024
+ &mdash;
1025
+ <div class='inline'><p>
1026
+ First item: parsed data; second item: raw body
1027
+ </p>
1028
+ </div>
1029
+
1030
+ </li>
1031
+
1032
+ </ul>
1033
+
1034
+ </div><table class="source_code">
1035
+ <tr>
1036
+ <td>
1037
+ <pre class="lines">
1038
+
1039
+
1040
+ 62
1041
+ 63
1042
+ 64</pre>
1043
+ </td>
1044
+ <td>
1045
+ <pre class="code"><span class="info file"># File 'lib/katello_api/resources/compute_resource.rb', line 62</span>
1046
+
1047
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_update identifier id'>update</span><span class='lparen token'>(</span><span class='rubyid_params identifier id'>params</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
1048
+ <span class='rubyid_perform_call identifier id'>perform_call</span><span class='lparen token'>(</span><span class='rubyid___method__ identifier id'>__method__</span><span class='comma token'>,</span> <span class='rubyid_params identifier id'>params</span><span class='comma token'>,</span> <span class='rubyid_headers identifier id'>headers</span><span class='rparen token'>)</span>
1049
+ <span class='rubyid_end end kw'>end</span>
1050
+ </pre>
1051
+ </td>
1052
+ </tr>
1053
+ </table>
1054
+ </div>
1055
+
1056
+ </div>
1057
+
1058
+ </div>
1059
+
1060
+ <div id="footer">
1061
+ Generated on Mon Mar 18 14:17:49 2013 by
1062
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1063
+ 0.8.5.2 (ruby-1.8.7).
1064
+ </div>
1065
+
1066
+ </body>
1067
+ </html>