1and1 1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (290) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +2 -0
  3. data/1and1-1.0.gem +0 -0
  4. data/1and1.gemspec +20 -0
  5. data/Gemfile +4 -0
  6. data/LICENSE +201 -0
  7. data/README.md +499 -0
  8. data/docs/reference.md +2447 -0
  9. data/examples/dvd_examples.rb +15 -0
  10. data/examples/example_app.rb +100 -0
  11. data/examples/firewall_examples.rb +137 -0
  12. data/examples/image_examples.rb +48 -0
  13. data/examples/load_balancer_examples.rb +145 -0
  14. data/examples/log_examples.rb +15 -0
  15. data/examples/monitoring_center_examples.rb +15 -0
  16. data/examples/monitoring_policy_examples.rb +343 -0
  17. data/examples/private_network_examples.rb +86 -0
  18. data/examples/public_ip_examples.rb +42 -0
  19. data/examples/role_examples.rb +113 -0
  20. data/examples/server_appliance_examples.rb +15 -0
  21. data/examples/server_examples.rb +438 -0
  22. data/examples/shared_storage_examples.rb +108 -0
  23. data/examples/usage_examples.rb +6 -0
  24. data/examples/user_examples.rb +113 -0
  25. data/examples/vpn_examples.rb +56 -0
  26. data/lib/1and1/datacenter.rb +73 -0
  27. data/lib/1and1/dvd.rb +73 -0
  28. data/lib/1and1/firewall.rb +427 -0
  29. data/lib/1and1/image.rb +231 -0
  30. data/lib/1and1/load_balancer.rb +448 -0
  31. data/lib/1and1/log.rb +77 -0
  32. data/lib/1and1/monitoring_center.rb +84 -0
  33. data/lib/1and1/monitoring_policy.rb +598 -0
  34. data/lib/1and1/oneandone.rb +57 -0
  35. data/lib/1and1/ping.rb +41 -0
  36. data/lib/1and1/ping_auth.rb +41 -0
  37. data/lib/1and1/pricing.rb +41 -0
  38. data/lib/1and1/private_network.rb +333 -0
  39. data/lib/1and1/public_ip.rb +192 -0
  40. data/lib/1and1/role.rb +381 -0
  41. data/lib/1and1/server.rb +1208 -0
  42. data/lib/1and1/server_appliance.rb +73 -0
  43. data/lib/1and1/shared_storage.rb +379 -0
  44. data/lib/1and1/usage.rb +58 -0
  45. data/lib/1and1/user.rb +374 -0
  46. data/lib/1and1/vpn.rb +249 -0
  47. data/lib/oneandone.rb +27 -0
  48. data/sphinx/Makefile +192 -0
  49. data/sphinx/_build/doctrees/dvds.doctree +0 -0
  50. data/sphinx/_build/doctrees/environment.pickle +0 -0
  51. data/sphinx/_build/doctrees/firewalls.doctree +0 -0
  52. data/sphinx/_build/doctrees/images.doctree +0 -0
  53. data/sphinx/_build/doctrees/index.doctree +0 -0
  54. data/sphinx/_build/doctrees/load_balancers.doctree +0 -0
  55. data/sphinx/_build/doctrees/logs.doctree +0 -0
  56. data/sphinx/_build/doctrees/monitoring_center.doctree +0 -0
  57. data/sphinx/_build/doctrees/monitoring_policies.doctree +0 -0
  58. data/sphinx/_build/doctrees/private_networks.doctree +0 -0
  59. data/sphinx/_build/doctrees/public_ips.doctree +0 -0
  60. data/sphinx/_build/doctrees/server_appliances.doctree +0 -0
  61. data/sphinx/_build/doctrees/servers.doctree +0 -0
  62. data/sphinx/_build/doctrees/shared_storages.doctree +0 -0
  63. data/sphinx/_build/doctrees/usages.doctree +0 -0
  64. data/sphinx/_build/doctrees/users.doctree +0 -0
  65. data/sphinx/_build/html/.buildinfo +4 -0
  66. data/sphinx/_build/html/_sources/dvds.txt +42 -0
  67. data/sphinx/_build/html/_sources/firewalls.txt +189 -0
  68. data/sphinx/_build/html/_sources/images.txt +101 -0
  69. data/sphinx/_build/html/_sources/index.txt +499 -0
  70. data/sphinx/_build/html/_sources/load_balancers.txt +231 -0
  71. data/sphinx/_build/html/_sources/logs.txt +55 -0
  72. data/sphinx/_build/html/_sources/monitoring_center.txt +55 -0
  73. data/sphinx/_build/html/_sources/monitoring_policies.txt +288 -0
  74. data/sphinx/_build/html/_sources/private_networks.txt +146 -0
  75. data/sphinx/_build/html/_sources/public_ips.txt +78 -0
  76. data/sphinx/_build/html/_sources/server_appliances.txt +42 -0
  77. data/sphinx/_build/html/_sources/servers.txt +630 -0
  78. data/sphinx/_build/html/_sources/shared_storages.txt +160 -0
  79. data/sphinx/_build/html/_sources/usages.txt +45 -0
  80. data/sphinx/_build/html/_sources/users.txt +172 -0
  81. data/sphinx/_build/html/_static/ajax-loader.gif +0 -0
  82. data/sphinx/_build/html/_static/alabaster.css +585 -0
  83. data/sphinx/_build/html/_static/basic.css +599 -0
  84. data/sphinx/_build/html/_static/comment-bright.png +0 -0
  85. data/sphinx/_build/html/_static/comment-close.png +0 -0
  86. data/sphinx/_build/html/_static/comment.png +0 -0
  87. data/sphinx/_build/html/_static/doctools.js +263 -0
  88. data/sphinx/_build/html/_static/down-pressed.png +0 -0
  89. data/sphinx/_build/html/_static/down.png +0 -0
  90. data/sphinx/_build/html/_static/file.png +0 -0
  91. data/sphinx/_build/html/_static/jquery-1.11.1.js +10308 -0
  92. data/sphinx/_build/html/_static/jquery.js +4 -0
  93. data/sphinx/_build/html/_static/minus.png +0 -0
  94. data/sphinx/_build/html/_static/plus.png +0 -0
  95. data/sphinx/_build/html/_static/pygments.css +63 -0
  96. data/sphinx/_build/html/_static/searchtools.js +651 -0
  97. data/sphinx/_build/html/_static/underscore-1.3.1.js +999 -0
  98. data/sphinx/_build/html/_static/underscore.js +31 -0
  99. data/sphinx/_build/html/_static/up-pressed.png +0 -0
  100. data/sphinx/_build/html/_static/up.png +0 -0
  101. data/sphinx/_build/html/_static/websupport.js +808 -0
  102. data/sphinx/_build/html/dvds.html +151 -0
  103. data/sphinx/_build/html/firewalls.html +397 -0
  104. data/sphinx/_build/html/genindex.html +114 -0
  105. data/sphinx/_build/html/images.html +236 -0
  106. data/sphinx/_build/html/index.html +571 -0
  107. data/sphinx/_build/html/load_balancers.html +409 -0
  108. data/sphinx/_build/html/logs.html +160 -0
  109. data/sphinx/_build/html/monitoring_center.html +160 -0
  110. data/sphinx/_build/html/monitoring_policies.html +530 -0
  111. data/sphinx/_build/html/objects.inv +0 -0
  112. data/sphinx/_build/html/private_networks.html +316 -0
  113. data/sphinx/_build/html/public_ips.html +215 -0
  114. data/sphinx/_build/html/rb-modindex.html +106 -0
  115. data/sphinx/_build/html/search.html +99 -0
  116. data/sphinx/_build/html/searchindex.js +1 -0
  117. data/sphinx/_build/html/server_appliances.html +153 -0
  118. data/sphinx/_build/html/servers.html +994 -0
  119. data/sphinx/_build/html/shared_storages.html +349 -0
  120. data/sphinx/_build/html/usages.html +140 -0
  121. data/sphinx/_build/html/users.html +363 -0
  122. data/sphinx/conf.py +287 -0
  123. data/sphinx/dvds.rst +42 -0
  124. data/sphinx/firewalls.rst +189 -0
  125. data/sphinx/images.rst +101 -0
  126. data/sphinx/index.rst +499 -0
  127. data/sphinx/load_balancers.rst +231 -0
  128. data/sphinx/logs.rst +55 -0
  129. data/sphinx/make.bat +263 -0
  130. data/sphinx/monitoring_center.rst +55 -0
  131. data/sphinx/monitoring_policies.rst +288 -0
  132. data/sphinx/private_networks.rst +146 -0
  133. data/sphinx/public_ips.rst +78 -0
  134. data/sphinx/server_appliances.rst +42 -0
  135. data/sphinx/servers.rst +630 -0
  136. data/sphinx/shared_storages.rst +160 -0
  137. data/sphinx/usages.rst +45 -0
  138. data/sphinx/users.rst +172 -0
  139. data/test/mock-api/add-firewall.json +66 -0
  140. data/test/mock-api/add-hdd.json +49 -0
  141. data/test/mock-api/add-lb.json +71 -0
  142. data/test/mock-api/add-new-ip.json +18 -0
  143. data/test/mock-api/add-pn.json +66 -0
  144. data/test/mock-api/add-port-mp.json +81 -0
  145. data/test/mock-api/add-process-mp.json +20 -0
  146. data/test/mock-api/add-rule-fp.json +33 -0
  147. data/test/mock-api/add-rule-lb.json +40 -0
  148. data/test/mock-api/add-server-ip.json +66 -0
  149. data/test/mock-api/add-server-mp.json +66 -0
  150. data/test/mock-api/assign-ip-fp.json +32 -0
  151. data/test/mock-api/assign-server-lb.json +39 -0
  152. data/test/mock-api/attach-server-pn.json +14 -0
  153. data/test/mock-api/attach-server-storage.json +24 -0
  154. data/test/mock-api/change-api-key.json +15 -0
  155. data/test/mock-api/change-password.json +5 -0
  156. data/test/mock-api/change-server-status.json +70 -0
  157. data/test/mock-api/clone-server.json +29 -0
  158. data/test/mock-api/create-fp.json +26 -0
  159. data/test/mock-api/create-image.json +30 -0
  160. data/test/mock-api/create-lb.json +33 -0
  161. data/test/mock-api/create-mp.json +81 -0
  162. data/test/mock-api/create-pn.json +11 -0
  163. data/test/mock-api/create-public-ip.json +10 -0
  164. data/test/mock-api/create-server.json +34 -0
  165. data/test/mock-api/create-snapshot.json +74 -0
  166. data/test/mock-api/create-storage.json +13 -0
  167. data/test/mock-api/create-user.json +14 -0
  168. data/test/mock-api/delete-fp.json +26 -0
  169. data/test/mock-api/delete-image.json +26 -0
  170. data/test/mock-api/delete-ip.json +15 -0
  171. data/test/mock-api/delete-lb.json +33 -0
  172. data/test/mock-api/delete-mp.json +71 -0
  173. data/test/mock-api/delete-pn.json +11 -0
  174. data/test/mock-api/delete-public-ip.json +10 -0
  175. data/test/mock-api/delete-rule-fp.json +26 -0
  176. data/test/mock-api/delete-server.json +50 -0
  177. data/test/mock-api/delete-snapshot.json +74 -0
  178. data/test/mock-api/delete-storage.json +24 -0
  179. data/test/mock-api/delete-user.json +15 -0
  180. data/test/mock-api/detach-server-lb.json +33 -0
  181. data/test/mock-api/detach-server-mp.json +65 -0
  182. data/test/mock-api/detach-server-storage.json +19 -0
  183. data/test/mock-api/edit-image.json +26 -0
  184. data/test/mock-api/eject-dvd.json +66 -0
  185. data/test/mock-api/fixed-server-flavors.json +70 -0
  186. data/test/mock-api/get-appliance.json +16 -0
  187. data/test/mock-api/get-dvd.json +9 -0
  188. data/test/mock-api/get-firewall.json +26 -0
  189. data/test/mock-api/get-fixed-server.json +17 -0
  190. data/test/mock-api/get-fp-rule.json +7 -0
  191. data/test/mock-api/get-hardware.json +13 -0
  192. data/test/mock-api/get-hdd.json +5 -0
  193. data/test/mock-api/get-image.json +26 -0
  194. data/test/mock-api/get-lb-rule.json +7 -0
  195. data/test/mock-api/get-lb-server.json +5 -0
  196. data/test/mock-api/get-load-balancer.json +33 -0
  197. data/test/mock-api/get-log.json +23 -0
  198. data/test/mock-api/get-monitoring-center.json +161 -0
  199. data/test/mock-api/get-mp-port.json +7 -0
  200. data/test/mock-api/get-mp-process.json +6 -0
  201. data/test/mock-api/get-mp-server.json +4 -0
  202. data/test/mock-api/get-mp.json +65 -0
  203. data/test/mock-api/get-pn-server.json +4 -0
  204. data/test/mock-api/get-private-network.json +20 -0
  205. data/test/mock-api/get-public-ip.json +10 -0
  206. data/test/mock-api/get-server-dvd.json +4 -0
  207. data/test/mock-api/get-server-image.json +4 -0
  208. data/test/mock-api/get-server-ip-fp.json +4 -0
  209. data/test/mock-api/get-server-ip.json +8 -0
  210. data/test/mock-api/get-server-pn.json +16 -0
  211. data/test/mock-api/get-server-status.json +4 -0
  212. data/test/mock-api/get-server-storage.json +5 -0
  213. data/test/mock-api/get-server.json +44 -0
  214. data/test/mock-api/get-storage.json +19 -0
  215. data/test/mock-api/get-usage.json +161 -0
  216. data/test/mock-api/get-user-api-key.json +3 -0
  217. data/test/mock-api/get-user-api.json +7 -0
  218. data/test/mock-api/get-user.json +15 -0
  219. data/test/mock-api/list-appliances.json +66 -0
  220. data/test/mock-api/list-credentials.json +5 -0
  221. data/test/mock-api/list-dvds.json +128 -0
  222. data/test/mock-api/list-firewalls.json +54 -0
  223. data/test/mock-api/list-fp-rules.json +16 -0
  224. data/test/mock-api/list-hdds.json +7 -0
  225. data/test/mock-api/list-images.json +54 -0
  226. data/test/mock-api/list-lb-rules.json +16 -0
  227. data/test/mock-api/list-lb-servers.json +12 -0
  228. data/test/mock-api/list-load-balancers.json +68 -0
  229. data/test/mock-api/list-logs.json +49 -0
  230. data/test/mock-api/list-monitoring-center-usages.json +90 -0
  231. data/test/mock-api/list-mp-ports.json +16 -0
  232. data/test/mock-api/list-mp-processes.json +14 -0
  233. data/test/mock-api/list-mp-servers.json +10 -0
  234. data/test/mock-api/list-mps.json +152 -0
  235. data/test/mock-api/list-pn-servers.json +10 -0
  236. data/test/mock-api/list-private-networks.json +24 -0
  237. data/test/mock-api/list-public-ips.json +44 -0
  238. data/test/mock-api/list-server-fps.json +4 -0
  239. data/test/mock-api/list-server-ips-fp.json +7 -0
  240. data/test/mock-api/list-server-ips.json +10 -0
  241. data/test/mock-api/list-server-lbs.json +6 -0
  242. data/test/mock-api/list-server-pns.json +6 -0
  243. data/test/mock-api/list-servers.json +66 -0
  244. data/test/mock-api/list-snapshots.json +7 -0
  245. data/test/mock-api/list-storages.json +47 -0
  246. data/test/mock-api/list-usages.json +144 -0
  247. data/test/mock-api/list-user-ips.json +5 -0
  248. data/test/mock-api/list-users.json +31 -0
  249. data/test/mock-api/load-dvd.json +63 -0
  250. data/test/mock-api/modify-fp.json +26 -0
  251. data/test/mock-api/modify-lb.json +33 -0
  252. data/test/mock-api/modify-mp.json +81 -0
  253. data/test/mock-api/modify-pn.json +20 -0
  254. data/test/mock-api/modify-port-mp.json +81 -0
  255. data/test/mock-api/modify-process-mp.json +73 -0
  256. data/test/mock-api/modify-public-ip.json +10 -0
  257. data/test/mock-api/modify-server-hardware.json +44 -0
  258. data/test/mock-api/modify-server-hdd.json +54 -0
  259. data/test/mock-api/modify-server.json +44 -0
  260. data/test/mock-api/modify-storage.json +19 -0
  261. data/test/mock-api/modify-user-api.json +15 -0
  262. data/test/mock-api/modify-user.json +15 -0
  263. data/test/mock-api/reinstall-image.json +52 -0
  264. data/test/mock-api/remove-firewall-policy.json +26 -0
  265. data/test/mock-api/remove-hdd.json +54 -0
  266. data/test/mock-api/remove-ip-fp.json +26 -0
  267. data/test/mock-api/remove-lb.json +66 -0
  268. data/test/mock-api/remove-pn.json +71 -0
  269. data/test/mock-api/remove-port-mp.json +73 -0
  270. data/test/mock-api/remove-process-mp.json +66 -0
  271. data/test/mock-api/remove-rule-lb.json +33 -0
  272. data/test/mock-api/remove-server-ip.json +58 -0
  273. data/test/mock-api/remove-server-pn.json +16 -0
  274. data/test/mock-api/restore-snapshot.json +55 -0
  275. data/test/mock-api/storage-servers.json +12 -0
  276. data/test/test_mock_dvd.rb +55 -0
  277. data/test/test_mock_firewall.rb +309 -0
  278. data/test/test_mock_image.rb +123 -0
  279. data/test/test_mock_load_balancer.rb +312 -0
  280. data/test/test_mock_log.rb +55 -0
  281. data/test/test_mock_monitoring_center.rb +55 -0
  282. data/test/test_mock_monitoring_policy.rb +587 -0
  283. data/test/test_mock_private_network.rb +206 -0
  284. data/test/test_mock_public_ip.rb +118 -0
  285. data/test/test_mock_server.rb +929 -0
  286. data/test/test_mock_server_appliance.rb +55 -0
  287. data/test/test_mock_shared_storage.rb +256 -0
  288. data/test/test_mock_usage.rb +34 -0
  289. data/test/test_mock_user.rb +270 -0
  290. metadata +360 -0
@@ -0,0 +1,151 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml">
6
+ <head>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+
9
+ <title>DVD’s &mdash; 1and1 Ruby SDK 1.0 documentation</title>
10
+
11
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
12
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
+
14
+ <script type="text/javascript">
15
+ var DOCUMENTATION_OPTIONS = {
16
+ URL_ROOT: './',
17
+ VERSION: '1.0',
18
+ COLLAPSE_INDEX: false,
19
+ FILE_SUFFIX: '.html',
20
+ HAS_SOURCE: true
21
+ };
22
+ </script>
23
+ <script type="text/javascript" src="_static/jquery.js"></script>
24
+ <script type="text/javascript" src="_static/underscore.js"></script>
25
+ <script type="text/javascript" src="_static/doctools.js"></script>
26
+ <link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
27
+ <link rel="prev" title="Server Appliances" href="server_appliances.html" />
28
+
29
+
30
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
31
+
32
+ </head>
33
+ <body role="document">
34
+
35
+ <div class="document">
36
+ <div class="documentwrapper">
37
+ <div class="bodywrapper">
38
+ <div class="body" role="main">
39
+
40
+ <div class="section" id="dvd-s">
41
+ <h1>DVD&#8217;s<a class="headerlink" href="#dvd-s" title="Permalink to this headline">¶</a></h1>
42
+ <dl class="class">
43
+ <dt>
44
+ <code class="descname">OneAndOne::Dvd()</code></dt>
45
+ <dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">Dvd</span></code> class allows a user to perform actions against the 1and1 API.</p>
46
+ <dl class="method">
47
+ <dt id="list">
48
+ <code class="descname">list</code><span class="sig-paren">(</span><em>page: nil</em>, <em>per_page: nil</em>, <em>sort: nil</em>, <em>q: nil</em>, <em>fields: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#list" title="Permalink to this definition">¶</a></dt>
49
+ <dd><p>List all DVD&#8217;s on your account.</p>
50
+ <table class="docutils field-list" frame="void" rules="none">
51
+ <col class="field-name" />
52
+ <col class="field-body" />
53
+ <tbody valign="top">
54
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
55
+ <li><strong>page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) &#8211; Allows the use of pagination. Indicate which page to start on.</li>
56
+ <li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) &#8211; Number of items per page.</li>
57
+ <li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'name'</span></code> retrieves a list of elements sorted
58
+ alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
59
+ sorted by their creation date in descending order.</li>
60
+ <li><strong>q</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; <code class="docutils literal"><span class="pre">q</span></code> is for query. Use this parameter to return only the items
61
+ that match your search query.</li>
62
+ <li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; Returns only the parameters requested.
63
+ (i.e. fields: &#8216;id, name, description, hardware.ram&#8217;)</li>
64
+ </ul>
65
+ </td>
66
+ </tr>
67
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
68
+ </td>
69
+ </tr>
70
+ </tbody>
71
+ </table>
72
+ </dd></dl>
73
+
74
+ <dl class="method">
75
+ <dt id="get">
76
+ <code class="descname">get</code><span class="sig-paren">(</span><em>dvd_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
77
+ <dd><p>Returns information about a DVD.</p>
78
+ <table class="docutils field-list" frame="void" rules="none">
79
+ <col class="field-name" />
80
+ <col class="field-body" />
81
+ <tbody valign="top">
82
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
83
+ <li><strong>dvd_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the DVD.</li>
84
+ </ul>
85
+ </td>
86
+ </tr>
87
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
88
+ </td>
89
+ </tr>
90
+ </tbody>
91
+ </table>
92
+ </dd></dl>
93
+
94
+ </dd></dl>
95
+
96
+ </div>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ </div>
102
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
103
+ <div class="sphinxsidebarwrapper"><div class="relations">
104
+ <h3>Related Topics</h3>
105
+ <ul>
106
+ <li><a href="index.html">Documentation overview</a><ul>
107
+ <li>Previous: <a href="server_appliances.html" title="previous chapter">Server Appliances</a></li>
108
+ </ul></li>
109
+ </ul>
110
+ </div>
111
+ <div role="note" aria-label="source link">
112
+ <h3>This Page</h3>
113
+ <ul class="this-page-menu">
114
+ <li><a href="_sources/dvds.txt"
115
+ rel="nofollow">Show Source</a></li>
116
+ </ul>
117
+ </div>
118
+ <div id="searchbox" style="display: none" role="search">
119
+ <h3>Quick search</h3>
120
+ <form class="search" action="search.html" method="get">
121
+ <input type="text" name="q" />
122
+ <input type="submit" value="Go" />
123
+ <input type="hidden" name="check_keywords" value="yes" />
124
+ <input type="hidden" name="area" value="default" />
125
+ </form>
126
+ <p class="searchtip" style="font-size: 90%">
127
+ Enter search terms or a module, class or function name.
128
+ </p>
129
+ </div>
130
+ <script type="text/javascript">$('#searchbox').show(0);</script>
131
+ </div>
132
+ </div>
133
+ <div class="clearer"></div>
134
+ </div>
135
+ <div class="footer">
136
+ &copy;2016, StackPointCloud, Inc..
137
+
138
+ |
139
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
140
+ &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
141
+
142
+ |
143
+ <a href="_sources/dvds.txt"
144
+ rel="nofollow">Page source</a>
145
+ </div>
146
+
147
+
148
+
149
+
150
+ </body>
151
+ </html>
@@ -0,0 +1,397 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml">
6
+ <head>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+
9
+ <title>Firewall Policies &mdash; 1and1 Ruby SDK 1.0 documentation</title>
10
+
11
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
12
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
+
14
+ <script type="text/javascript">
15
+ var DOCUMENTATION_OPTIONS = {
16
+ URL_ROOT: './',
17
+ VERSION: '1.0',
18
+ COLLAPSE_INDEX: false,
19
+ FILE_SUFFIX: '.html',
20
+ HAS_SOURCE: true
21
+ };
22
+ </script>
23
+ <script type="text/javascript" src="_static/jquery.js"></script>
24
+ <script type="text/javascript" src="_static/underscore.js"></script>
25
+ <script type="text/javascript" src="_static/doctools.js"></script>
26
+ <link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
27
+ <link rel="next" title="Load Balancers" href="load_balancers.html" />
28
+ <link rel="prev" title="Shared Storages" href="shared_storages.html" />
29
+
30
+
31
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
32
+
33
+ </head>
34
+ <body role="document">
35
+
36
+ <div class="document">
37
+ <div class="documentwrapper">
38
+ <div class="bodywrapper">
39
+ <div class="body" role="main">
40
+
41
+ <div class="section" id="firewall-policies">
42
+ <h1>Firewall Policies<a class="headerlink" href="#firewall-policies" title="Permalink to this headline">¶</a></h1>
43
+ <dl class="class">
44
+ <dt>
45
+ <code class="descname">OneAndOne::Firewall()</code></dt>
46
+ <dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">Firewall</span></code> class allows a user to perform actions against the 1and1 API.</p>
47
+ <dl class="method">
48
+ <dt id="list">
49
+ <code class="descname">list</code><span class="sig-paren">(</span><em>page: nil</em>, <em>per_page: nil</em>, <em>sort: nil</em>, <em>q: nil</em>, <em>fields: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#list" title="Permalink to this definition">¶</a></dt>
50
+ <dd><p>Return a list of all shared storages.</p>
51
+ <table class="docutils field-list" frame="void" rules="none">
52
+ <col class="field-name" />
53
+ <col class="field-body" />
54
+ <tbody valign="top">
55
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
56
+ <li><strong>page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) &#8211; Allows the use of pagination. Indicate which page to start on.</li>
57
+ <li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) &#8211; Number of items per page.</li>
58
+ <li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'name'</span></code> retrieves a list of elements sorted
59
+ alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
60
+ sorted by their creation date in descending order.</li>
61
+ <li><strong>q</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; <code class="docutils literal"><span class="pre">q</span></code> is for query. Use this parameter to return only the items
62
+ that match your search query.</li>
63
+ <li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; Returns only the parameters requested.
64
+ (i.e. fields: &#8216;id, name, description, hardware.ram&#8217;)</li>
65
+ </ul>
66
+ </td>
67
+ </tr>
68
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
69
+ </td>
70
+ </tr>
71
+ </tbody>
72
+ </table>
73
+ </dd></dl>
74
+
75
+ <dl class="method">
76
+ <dt id="create">
77
+ <code class="descname">create</code><span class="sig-paren">(</span><em>name: nil</em>, <em>description: nil</em>, <em>rules: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#create" title="Permalink to this definition">¶</a></dt>
78
+ <dd><p>Create a firewall policy.</p>
79
+ <table class="docutils field-list" frame="void" rules="none">
80
+ <col class="field-name" />
81
+ <col class="field-body" />
82
+ <tbody valign="top">
83
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
84
+ <li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; firewall policy&#8217;s name.</li>
85
+ <li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; firewall policy&#8217;s name.</li>
86
+ <li><strong>rules</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of rules for the new firewall policy.</li>
87
+ </ul>
88
+ </td>
89
+ </tr>
90
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
91
+ </td>
92
+ </tr>
93
+ </tbody>
94
+ </table>
95
+ </dd></dl>
96
+
97
+ <dl class="method">
98
+ <dt id="get">
99
+ <code class="descname">get</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
100
+ <dd><p>Returns a firewall policy&#8217;s current specs.</p>
101
+ <table class="docutils field-list" frame="void" rules="none">
102
+ <col class="field-name" />
103
+ <col class="field-body" />
104
+ <tbody valign="top">
105
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
106
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall.</li>
107
+ </ul>
108
+ </td>
109
+ </tr>
110
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
111
+ </td>
112
+ </tr>
113
+ </tbody>
114
+ </table>
115
+ </dd></dl>
116
+
117
+ <dl class="method">
118
+ <dt id="modify">
119
+ <code class="descname">modify</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>name: nil</em>, <em>description: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify" title="Permalink to this definition">¶</a></dt>
120
+ <dd><p>Modify a firewall policy.</p>
121
+ <table class="docutils field-list" frame="void" rules="none">
122
+ <col class="field-name" />
123
+ <col class="field-body" />
124
+ <tbody valign="top">
125
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
126
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
127
+ <li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; firewall policy name.</li>
128
+ <li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; firewall policy description.</li>
129
+ </ul>
130
+ </td>
131
+ </tr>
132
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
133
+ </td>
134
+ </tr>
135
+ </tbody>
136
+ </table>
137
+ </dd></dl>
138
+
139
+ <dl class="method">
140
+ <dt id="delete">
141
+ <code class="descname">delete</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#delete" title="Permalink to this definition">¶</a></dt>
142
+ <dd><p>Delete a firewall policy.</p>
143
+ <table class="docutils field-list" frame="void" rules="none">
144
+ <col class="field-name" />
145
+ <col class="field-body" />
146
+ <tbody valign="top">
147
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
148
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall.</li>
149
+ </ul>
150
+ </td>
151
+ </tr>
152
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
153
+ </td>
154
+ </tr>
155
+ </tbody>
156
+ </table>
157
+ </dd></dl>
158
+
159
+ <dl class="method">
160
+ <dt id="ips">
161
+ <code class="descname">ips</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#ips" title="Permalink to this definition">¶</a></dt>
162
+ <dd><p>Returns a list of the IPs assigned to a firewall policy.</p>
163
+ <table class="docutils field-list" frame="void" rules="none">
164
+ <col class="field-name" />
165
+ <col class="field-body" />
166
+ <tbody valign="top">
167
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
168
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall.</li>
169
+ </ul>
170
+ </td>
171
+ </tr>
172
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
173
+ </td>
174
+ </tr>
175
+ </tbody>
176
+ </table>
177
+ </dd></dl>
178
+
179
+ <dl class="method">
180
+ <dt id="ip">
181
+ <code class="descname">ip</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#ip" title="Permalink to this definition">¶</a></dt>
182
+ <dd><p>Returns information about an IP assigned to a firewall policy.</p>
183
+ <table class="docutils field-list" frame="void" rules="none">
184
+ <col class="field-name" />
185
+ <col class="field-body" />
186
+ <tbody valign="top">
187
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
188
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
189
+ <li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the IP.</li>
190
+ </ul>
191
+ </td>
192
+ </tr>
193
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
194
+ </td>
195
+ </tr>
196
+ </tbody>
197
+ </table>
198
+ </dd></dl>
199
+
200
+ <dl class="method">
201
+ <dt id="add_ips">
202
+ <code class="descname">add_ips</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>ips: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_ips" title="Permalink to this definition">¶</a></dt>
203
+ <dd><p>Add IPs to a firewall policy.</p>
204
+ <table class="docutils field-list" frame="void" rules="none">
205
+ <col class="field-name" />
206
+ <col class="field-body" />
207
+ <tbody valign="top">
208
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
209
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
210
+ <li><strong>ips</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of IP ID&#8217;s for the new firewall policy..</li>
211
+ </ul>
212
+ </td>
213
+ </tr>
214
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
215
+ </td>
216
+ </tr>
217
+ </tbody>
218
+ </table>
219
+ </dd></dl>
220
+
221
+ <dl class="method">
222
+ <dt id="remove_ip">
223
+ <code class="descname">remove_ip</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_ip" title="Permalink to this definition">¶</a></dt>
224
+ <dd><p>Remove an IP from a firewall policy.</p>
225
+ <table class="docutils field-list" frame="void" rules="none">
226
+ <col class="field-name" />
227
+ <col class="field-body" />
228
+ <tbody valign="top">
229
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
230
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
231
+ <li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the IP.</li>
232
+ </ul>
233
+ </td>
234
+ </tr>
235
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
236
+ </td>
237
+ </tr>
238
+ </tbody>
239
+ </table>
240
+ </dd></dl>
241
+
242
+ <dl class="method">
243
+ <dt id="rules">
244
+ <code class="descname">rules</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#rules" title="Permalink to this definition">¶</a></dt>
245
+ <dd><p>Returns a list the firewall policy&#8217;s rules.</p>
246
+ <table class="docutils field-list" frame="void" rules="none">
247
+ <col class="field-name" />
248
+ <col class="field-body" />
249
+ <tbody valign="top">
250
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
251
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall.</li>
252
+ </ul>
253
+ </td>
254
+ </tr>
255
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
256
+ </td>
257
+ </tr>
258
+ </tbody>
259
+ </table>
260
+ </dd></dl>
261
+
262
+ <dl class="method">
263
+ <dt id="rule">
264
+ <code class="descname">rule</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>rule_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#rule" title="Permalink to this definition">¶</a></dt>
265
+ <dd><p>Returns information about a firewall policy&#8217;s rule.</p>
266
+ <table class="docutils field-list" frame="void" rules="none">
267
+ <col class="field-name" />
268
+ <col class="field-body" />
269
+ <tbody valign="top">
270
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
271
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
272
+ <li><strong>rule_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall rule.</li>
273
+ </ul>
274
+ </td>
275
+ </tr>
276
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
277
+ </td>
278
+ </tr>
279
+ </tbody>
280
+ </table>
281
+ </dd></dl>
282
+
283
+ <dl class="method">
284
+ <dt id="add_rules">
285
+ <code class="descname">add_rules</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>rules: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_rules" title="Permalink to this definition">¶</a></dt>
286
+ <dd><p>Add rules to a firewall policy.</p>
287
+ <table class="docutils field-list" frame="void" rules="none">
288
+ <col class="field-name" />
289
+ <col class="field-body" />
290
+ <tbody valign="top">
291
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
292
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
293
+ <li><strong>rules</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of rule objects.</li>
294
+ </ul>
295
+ </td>
296
+ </tr>
297
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
298
+ </td>
299
+ </tr>
300
+ </tbody>
301
+ </table>
302
+ </dd></dl>
303
+
304
+ <dl class="method">
305
+ <dt id="remove_rule">
306
+ <code class="descname">remove_rule</code><span class="sig-paren">(</span><em>firewall_id: &#64;id</em>, <em>rule_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_rule" title="Permalink to this definition">¶</a></dt>
307
+ <dd><p>Remove a firewall policy&#8217;s rule.</p>
308
+ <table class="docutils field-list" frame="void" rules="none">
309
+ <col class="field-name" />
310
+ <col class="field-body" />
311
+ <tbody valign="top">
312
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
313
+ <li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall policy.</li>
314
+ <li><strong>rule_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the firewall rule.</li>
315
+ </ul>
316
+ </td>
317
+ </tr>
318
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
319
+ </td>
320
+ </tr>
321
+ </tbody>
322
+ </table>
323
+ </dd></dl>
324
+
325
+ <dl class="method">
326
+ <dt id="wait_for">
327
+ <code class="descname">wait_for</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wait_for" title="Permalink to this definition">¶</a></dt>
328
+ <dd><p>Polls the firewall policy until an &#8220;ACTIVE&#8221; state is returned. Use this when chaining actions.</p>
329
+ <table class="docutils field-list" frame="void" rules="none">
330
+ <col class="field-name" />
331
+ <col class="field-body" />
332
+ <tbody valign="top">
333
+ <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal"><span class="pre">nil</span></code></td>
334
+ </tr>
335
+ </tbody>
336
+ </table>
337
+ </dd></dl>
338
+
339
+ </dd></dl>
340
+
341
+ </div>
342
+
343
+
344
+ </div>
345
+ </div>
346
+ </div>
347
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
348
+ <div class="sphinxsidebarwrapper"><div class="relations">
349
+ <h3>Related Topics</h3>
350
+ <ul>
351
+ <li><a href="index.html">Documentation overview</a><ul>
352
+ <li>Previous: <a href="shared_storages.html" title="previous chapter">Shared Storages</a></li>
353
+ <li>Next: <a href="load_balancers.html" title="next chapter">Load Balancers</a></li>
354
+ </ul></li>
355
+ </ul>
356
+ </div>
357
+ <div role="note" aria-label="source link">
358
+ <h3>This Page</h3>
359
+ <ul class="this-page-menu">
360
+ <li><a href="_sources/firewalls.txt"
361
+ rel="nofollow">Show Source</a></li>
362
+ </ul>
363
+ </div>
364
+ <div id="searchbox" style="display: none" role="search">
365
+ <h3>Quick search</h3>
366
+ <form class="search" action="search.html" method="get">
367
+ <input type="text" name="q" />
368
+ <input type="submit" value="Go" />
369
+ <input type="hidden" name="check_keywords" value="yes" />
370
+ <input type="hidden" name="area" value="default" />
371
+ </form>
372
+ <p class="searchtip" style="font-size: 90%">
373
+ Enter search terms or a module, class or function name.
374
+ </p>
375
+ </div>
376
+ <script type="text/javascript">$('#searchbox').show(0);</script>
377
+ </div>
378
+ </div>
379
+ <div class="clearer"></div>
380
+ </div>
381
+ <div class="footer">
382
+ &copy;2016, StackPointCloud, Inc..
383
+
384
+ |
385
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
386
+ &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
387
+
388
+ |
389
+ <a href="_sources/firewalls.txt"
390
+ rel="nofollow">Page source</a>
391
+ </div>
392
+
393
+
394
+
395
+
396
+ </body>
397
+ </html>