1and1 1.1

Sign up to get free protection for your applications and to get access to all the features.
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
data/sphinx/_build/html/monitoring_center.html ADDED
@@ -0,0 +1,160 @@
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>Monitoring Center &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="Monitoring Policies" href="monitoring_policies.html" />
28
+ <link rel="prev" title="Private Networks" href="private_networks.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="monitoring-center">
42
+ <h1>Monitoring Center<a class="headerlink" href="#monitoring-center" title="Permalink to this headline">¶</a></h1>
43
+ <dl class="class">
44
+ <dt>
45
+ <code class="descname">OneAndOne::MonitoringCenter()</code></dt>
46
+ <dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">MonitoringCenter</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>List all usages and alerts of monitoring servers.</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="get">
77
+ <code class="descname">get</code><span class="sig-paren">(</span><em>server_id: nil</em>, <em>period: nil</em>, <em>start_date: nil</em>, <em>end_date: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
78
+ <dd><p>Returns the usage of the resources for the specified time range.</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>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the server.</li>
85
+ <li><strong>period</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the time range of logs to be shown. Possible values are
86
+ <code class="docutils literal"><span class="pre">'LAST_HOUR'</span></code>, <code class="docutils literal"><span class="pre">'LAST_24H'</span></code>, <code class="docutils literal"><span class="pre">'LAST_7D'</span></code>, <code class="docutils literal"><span class="pre">'LAST_30D'</span></code>,
87
+ <code class="docutils literal"><span class="pre">'LAST_365D'</span></code>, or <code class="docutils literal"><span class="pre">'CUSTOM'</span></code></li>
88
+ <li><strong>start_date</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; start point. Only required if using <code class="docutils literal"><span class="pre">'CUSTOM'</span></code> for the
89
+ <code class="docutils literal"><span class="pre">period</span></code> parameter. <em>Format:</em> <code class="docutils literal"><span class="pre">2015-19-05T00:05:00Z</span></code></li>
90
+ <li><strong>end_date</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; end point. Only required if using <code class="docutils literal"><span class="pre">'CUSTOM'</span></code> for the
91
+ <code class="docutils literal"><span class="pre">period</span></code> parameter. <em>Format:</em> <code class="docutils literal"><span class="pre">2015-19-05T00:10:00Z</span></code></li>
92
+ </ul>
93
+ </td>
94
+ </tr>
95
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
96
+ </td>
97
+ </tr>
98
+ </tbody>
99
+ </table>
100
+ </dd></dl>
101
+
102
+ </dd></dl>
103
+
104
+ </div>
105
+
106
+
107
+ </div>
108
+ </div>
109
+ </div>
110
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
111
+ <div class="sphinxsidebarwrapper"><div class="relations">
112
+ <h3>Related Topics</h3>
113
+ <ul>
114
+ <li><a href="index.html">Documentation overview</a><ul>
115
+ <li>Previous: <a href="private_networks.html" title="previous chapter">Private Networks</a></li>
116
+ <li>Next: <a href="monitoring_policies.html" title="next chapter">Monitoring Policies</a></li>
117
+ </ul></li>
118
+ </ul>
119
+ </div>
120
+ <div role="note" aria-label="source link">
121
+ <h3>This Page</h3>
122
+ <ul class="this-page-menu">
123
+ <li><a href="_sources/monitoring_center.txt"
124
+ rel="nofollow">Show Source</a></li>
125
+ </ul>
126
+ </div>
127
+ <div id="searchbox" style="display: none" role="search">
128
+ <h3>Quick search</h3>
129
+ <form class="search" action="search.html" method="get">
130
+ <input type="text" name="q" />
131
+ <input type="submit" value="Go" />
132
+ <input type="hidden" name="check_keywords" value="yes" />
133
+ <input type="hidden" name="area" value="default" />
134
+ </form>
135
+ <p class="searchtip" style="font-size: 90%">
136
+ Enter search terms or a module, class or function name.
137
+ </p>
138
+ </div>
139
+ <script type="text/javascript">$('#searchbox').show(0);</script>
140
+ </div>
141
+ </div>
142
+ <div class="clearer"></div>
143
+ </div>
144
+ <div class="footer">
145
+ &copy;2016, StackPointCloud, Inc..
146
+
147
+ |
148
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
149
+ &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
150
+
151
+ |
152
+ <a href="_sources/monitoring_center.txt"
153
+ rel="nofollow">Page source</a>
154
+ </div>
155
+
156
+
157
+
158
+
159
+ </body>
160
+ </html>
data/sphinx/_build/html/monitoring_policies.html ADDED
@@ -0,0 +1,530 @@
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>Monitoring 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="Logs" href="logs.html" />
28
+ <link rel="prev" title="Monitoring Center" href="monitoring_center.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="monitoring-policies">
42
+ <h1>Monitoring Policies<a class="headerlink" href="#monitoring-policies" title="Permalink to this headline">¶</a></h1>
43
+ <dl class="class">
44
+ <dt>
45
+ <code class="descname">OneAndOne::MonitoringPolicy()</code></dt>
46
+ <dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">MonitoringPolicy</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 monitoring policies.</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>email: nil</em>, <em>agent: nil</em>, <em>thresholds: nil</em>, <em>ports: nil</em>, <em>processes: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#create" title="Permalink to this definition">¶</a></dt>
78
+ <dd><p>Create a monitoring 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; monitoring policy name.</li>
85
+ <li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy description.</li>
86
+ <li><strong>email</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; user&#8217;s email.</li>
87
+ <li><strong>agent</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) &#8211; set true for using agent.</li>
88
+ <li><strong>thresholds</strong> (<code class="docutils literal"><span class="pre">hash</span></code>) &#8211; a &#8220;thresholds hash&#8221; that sets warning and critical limits for <code class="docutils literal"><span class="pre">cpu</span></code>, <code class="docutils literal"><span class="pre">ram</span></code>, <code class="docutils literal"><span class="pre">disk</span></code>, <code class="docutils literal"><span class="pre">transfer</span></code>, and <code class="docutils literal"><span class="pre">internal_ping</span></code>.</li>
89
+ <li><strong>ports</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;port hashes&#8221;.</li>
90
+ <li><strong>processes</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;process hashes&#8221;.</li>
91
+ </ul>
92
+ </td>
93
+ </tr>
94
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
95
+ </td>
96
+ </tr>
97
+ </tbody>
98
+ </table>
99
+ </dd></dl>
100
+
101
+ <dl class="method">
102
+ <dt id="get">
103
+ <code class="descname">get</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
104
+ <dd><p>Returns a monitoring policy&#8217;s current specs.</p>
105
+ <table class="docutils field-list" frame="void" rules="none">
106
+ <col class="field-name" />
107
+ <col class="field-body" />
108
+ <tbody valign="top">
109
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
110
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
111
+ </ul>
112
+ </td>
113
+ </tr>
114
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
115
+ </td>
116
+ </tr>
117
+ </tbody>
118
+ </table>
119
+ </dd></dl>
120
+
121
+ <dl class="method">
122
+ <dt id="modify">
123
+ <code class="descname">modify</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>name: nil</em>, <em>description: nil</em>, <em>email: nil</em>, <em>thresholds: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify" title="Permalink to this definition">¶</a></dt>
124
+ <dd><p>Modify a monitoring policy.</p>
125
+ <table class="docutils field-list" frame="void" rules="none">
126
+ <col class="field-name" />
127
+ <col class="field-body" />
128
+ <tbody valign="top">
129
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
130
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
131
+ <li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy name.</li>
132
+ <li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy description.</li>
133
+ <li><strong>email</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; user&#8217;s email.</li>
134
+ <li><strong>thresholds</strong> (<code class="docutils literal"><span class="pre">hash</span></code>) &#8211; a &#8220;thresholds hash&#8221; that sets warning and critical limits for <code class="docutils literal"><span class="pre">cpu</span></code>, <code class="docutils literal"><span class="pre">ram</span></code>, <code class="docutils literal"><span class="pre">disk</span></code>, <code class="docutils literal"><span class="pre">transfer</span></code>, and <code class="docutils literal"><span class="pre">internal_ping</span></code>.</li>
135
+ </ul>
136
+ </td>
137
+ </tr>
138
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
139
+ </td>
140
+ </tr>
141
+ </tbody>
142
+ </table>
143
+ </dd></dl>
144
+
145
+ <dl class="method">
146
+ <dt id="delete">
147
+ <code class="descname">delete</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#delete" title="Permalink to this definition">¶</a></dt>
148
+ <dd><p>Delete a monitoring policy.</p>
149
+ <table class="docutils field-list" frame="void" rules="none">
150
+ <col class="field-name" />
151
+ <col class="field-body" />
152
+ <tbody valign="top">
153
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
154
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
155
+ </ul>
156
+ </td>
157
+ </tr>
158
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
159
+ </td>
160
+ </tr>
161
+ </tbody>
162
+ </table>
163
+ </dd></dl>
164
+
165
+ <dl class="method">
166
+ <dt id="ports">
167
+ <code class="descname">ports</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#ports" title="Permalink to this definition">¶</a></dt>
168
+ <dd><p>List a monitoring policy&#8217;s ports.</p>
169
+ <table class="docutils field-list" frame="void" rules="none">
170
+ <col class="field-name" />
171
+ <col class="field-body" />
172
+ <tbody valign="top">
173
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
174
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
175
+ </ul>
176
+ </td>
177
+ </tr>
178
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
179
+ </td>
180
+ </tr>
181
+ </tbody>
182
+ </table>
183
+ </dd></dl>
184
+
185
+ <dl class="method">
186
+ <dt id="add_ports">
187
+ <code class="descname">add_ports</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>ports: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_ports" title="Permalink to this definition">¶</a></dt>
188
+ <dd><p>Add ports to a monitoring policy.</p>
189
+ <table class="docutils field-list" frame="void" rules="none">
190
+ <col class="field-name" />
191
+ <col class="field-body" />
192
+ <tbody valign="top">
193
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
194
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
195
+ <li><strong>ports</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;port hashes&#8221;.</li>
196
+ </ul>
197
+ </td>
198
+ </tr>
199
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
200
+ </td>
201
+ </tr>
202
+ </tbody>
203
+ </table>
204
+ </dd></dl>
205
+
206
+ <dl class="method">
207
+ <dt id="port">
208
+ <code class="descname">port</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>port_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#port" title="Permalink to this definition">¶</a></dt>
209
+ <dd><p>Returns information about a monitoring policy&#8217;s port.</p>
210
+ <table class="docutils field-list" frame="void" rules="none">
211
+ <col class="field-name" />
212
+ <col class="field-body" />
213
+ <tbody valign="top">
214
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
215
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
216
+ <li><strong>port_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the port.</li>
217
+ </ul>
218
+ </td>
219
+ </tr>
220
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
221
+ </td>
222
+ </tr>
223
+ </tbody>
224
+ </table>
225
+ </dd></dl>
226
+
227
+ <dl class="method">
228
+ <dt id="modify_port">
229
+ <code class="descname">modify_port</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>port_id: nil</em>, <em>new_port: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify_port" title="Permalink to this definition">¶</a></dt>
230
+ <dd><p>Modify a monitoring policy&#8217;s port.</p>
231
+ <table class="docutils field-list" frame="void" rules="none">
232
+ <col class="field-name" />
233
+ <col class="field-body" />
234
+ <tbody valign="top">
235
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
236
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
237
+ <li><strong>port_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the port.</li>
238
+ <li><strong>new_port</strong> (<code class="docutils literal"><span class="pre">hash</span></code>) &#8211; takes a &#8220;port hash&#8221;,</li>
239
+ </ul>
240
+ </td>
241
+ </tr>
242
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
243
+ </td>
244
+ </tr>
245
+ </tbody>
246
+ </table>
247
+ </dd></dl>
248
+
249
+ <dl class="method">
250
+ <dt id="delete_port">
251
+ <code class="descname">delete_port</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>port_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#delete_port" title="Permalink to this definition">¶</a></dt>
252
+ <dd><p>Delete a monitoring policy&#8217;s port.</p>
253
+ <table class="docutils field-list" frame="void" rules="none">
254
+ <col class="field-name" />
255
+ <col class="field-body" />
256
+ <tbody valign="top">
257
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
258
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
259
+ <li><strong>port_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the port.</li>
260
+ </ul>
261
+ </td>
262
+ </tr>
263
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
264
+ </td>
265
+ </tr>
266
+ </tbody>
267
+ </table>
268
+ </dd></dl>
269
+
270
+ <dl class="method">
271
+ <dt id="processes">
272
+ <code class="descname">processes</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#processes" title="Permalink to this definition">¶</a></dt>
273
+ <dd><p>List a monitoring policy&#8217;s processes.</p>
274
+ <table class="docutils field-list" frame="void" rules="none">
275
+ <col class="field-name" />
276
+ <col class="field-body" />
277
+ <tbody valign="top">
278
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
279
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
280
+ </ul>
281
+ </td>
282
+ </tr>
283
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
284
+ </td>
285
+ </tr>
286
+ </tbody>
287
+ </table>
288
+ </dd></dl>
289
+
290
+ <dl class="method">
291
+ <dt id="process">
292
+ <code class="descname">process</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>process_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#process" title="Permalink to this definition">¶</a></dt>
293
+ <dd><p>Returns information about a monitoring policy&#8217;s process.</p>
294
+ <table class="docutils field-list" frame="void" rules="none">
295
+ <col class="field-name" />
296
+ <col class="field-body" />
297
+ <tbody valign="top">
298
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
299
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
300
+ <li><strong>process_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the process.</li>
301
+ </ul>
302
+ </td>
303
+ </tr>
304
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
305
+ </td>
306
+ </tr>
307
+ </tbody>
308
+ </table>
309
+ </dd></dl>
310
+
311
+ <dl class="method">
312
+ <dt id="add_processes">
313
+ <code class="descname">add_processes</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>processes: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_processes" title="Permalink to this definition">¶</a></dt>
314
+ <dd><p>Add processes to a monitoring policy.</p>
315
+ <table class="docutils field-list" frame="void" rules="none">
316
+ <col class="field-name" />
317
+ <col class="field-body" />
318
+ <tbody valign="top">
319
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
320
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
321
+ <li><strong>processes</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;process hashes&#8221;.</li>
322
+ </ul>
323
+ </td>
324
+ </tr>
325
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
326
+ </td>
327
+ </tr>
328
+ </tbody>
329
+ </table>
330
+ </dd></dl>
331
+
332
+ <dl class="method">
333
+ <dt id="modify_process">
334
+ <code class="descname">modify_process</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>process_id: nil</em>, <em>new_process: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify_process" title="Permalink to this definition">¶</a></dt>
335
+ <dd><p>Modify a monitoring policy&#8217;s process.</p>
336
+ <table class="docutils field-list" frame="void" rules="none">
337
+ <col class="field-name" />
338
+ <col class="field-body" />
339
+ <tbody valign="top">
340
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
341
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
342
+ <li><strong>process_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the process.</li>
343
+ <li><strong>new_process</strong> (<code class="docutils literal"><span class="pre">hash</span></code>) &#8211; takes a &#8220;process hash&#8221;,</li>
344
+ </ul>
345
+ </td>
346
+ </tr>
347
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
348
+ </td>
349
+ </tr>
350
+ </tbody>
351
+ </table>
352
+ </dd></dl>
353
+
354
+ <dl class="method">
355
+ <dt id="delete_process">
356
+ <code class="descname">delete_process</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>process_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#delete_process" title="Permalink to this definition">¶</a></dt>
357
+ <dd><p>Delete a monitoring policy&#8217;s process.</p>
358
+ <table class="docutils field-list" frame="void" rules="none">
359
+ <col class="field-name" />
360
+ <col class="field-body" />
361
+ <tbody valign="top">
362
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
363
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
364
+ <li><strong>process_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the process.</li>
365
+ </ul>
366
+ </td>
367
+ </tr>
368
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
369
+ </td>
370
+ </tr>
371
+ </tbody>
372
+ </table>
373
+ </dd></dl>
374
+
375
+ <dl class="method">
376
+ <dt id="servers">
377
+ <code class="descname">servers</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em><span class="sig-paren">)</span><a class="headerlink" href="#servers" title="Permalink to this definition">¶</a></dt>
378
+ <dd><p>List a monitoring policy&#8217;s servers.</p>
379
+ <table class="docutils field-list" frame="void" rules="none">
380
+ <col class="field-name" />
381
+ <col class="field-body" />
382
+ <tbody valign="top">
383
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
384
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
385
+ </ul>
386
+ </td>
387
+ </tr>
388
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
389
+ </td>
390
+ </tr>
391
+ </tbody>
392
+ </table>
393
+ </dd></dl>
394
+
395
+ <dl class="method">
396
+ <dt id="server">
397
+ <code class="descname">server</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>server_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#server" title="Permalink to this definition">¶</a></dt>
398
+ <dd><p>Returns information about a monitoring policy&#8217;s server.</p>
399
+ <table class="docutils field-list" frame="void" rules="none">
400
+ <col class="field-name" />
401
+ <col class="field-body" />
402
+ <tbody valign="top">
403
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
404
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
405
+ <li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the server.</li>
406
+ </ul>
407
+ </td>
408
+ </tr>
409
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
410
+ </td>
411
+ </tr>
412
+ </tbody>
413
+ </table>
414
+ </dd></dl>
415
+
416
+ <dl class="method">
417
+ <dt id="add_servers">
418
+ <code class="descname">add_servers</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>servers: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_servers" title="Permalink to this definition">¶</a></dt>
419
+ <dd><p>Add servers to a monitoring policy.</p>
420
+ <table class="docutils field-list" frame="void" rules="none">
421
+ <col class="field-name" />
422
+ <col class="field-body" />
423
+ <tbody valign="top">
424
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
425
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
426
+ <li><strong>servers</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of server ID strings.</li>
427
+ </ul>
428
+ </td>
429
+ </tr>
430
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
431
+ </td>
432
+ </tr>
433
+ </tbody>
434
+ </table>
435
+ </dd></dl>
436
+
437
+ <dl class="method">
438
+ <dt id="remove_server">
439
+ <code class="descname">remove_server</code><span class="sig-paren">(</span><em>monitoring_policy_id: &#64;id</em>, <em>server_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_server" title="Permalink to this definition">¶</a></dt>
440
+ <dd><p>Remove a server from a monitoring policy.</p>
441
+ <table class="docutils field-list" frame="void" rules="none">
442
+ <col class="field-name" />
443
+ <col class="field-body" />
444
+ <tbody valign="top">
445
+ <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
446
+ <li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the monitoring policy.</li>
447
+ <li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the server.</li>
448
+ </ul>
449
+ </td>
450
+ </tr>
451
+ <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
452
+ </td>
453
+ </tr>
454
+ </tbody>
455
+ </table>
456
+ </dd></dl>
457
+
458
+ <dl class="method">
459
+ <dt id="wait_for">
460
+ <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>
461
+ <dd><p>Polls the monitoring policy until an &#8220;ACTIVE&#8221; state is returned. Use this when chaining actions.</p>
462
+ <table class="docutils field-list" frame="void" rules="none">
463
+ <col class="field-name" />
464
+ <col class="field-body" />
465
+ <tbody valign="top">
466
+ <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>
467
+ </tr>
468
+ </tbody>
469
+ </table>
470
+ </dd></dl>
471
+
472
+ </dd></dl>
473
+
474
+ </div>
475
+
476
+
477
+ </div>
478
+ </div>
479
+ </div>
480
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
481
+ <div class="sphinxsidebarwrapper"><div class="relations">
482
+ <h3>Related Topics</h3>
483
+ <ul>
484
+ <li><a href="index.html">Documentation overview</a><ul>
485
+ <li>Previous: <a href="monitoring_center.html" title="previous chapter">Monitoring Center</a></li>
486
+ <li>Next: <a href="logs.html" title="next chapter">Logs</a></li>
487
+ </ul></li>
488
+ </ul>
489
+ </div>
490
+ <div role="note" aria-label="source link">
491
+ <h3>This Page</h3>
492
+ <ul class="this-page-menu">
493
+ <li><a href="_sources/monitoring_policies.txt"
494
+ rel="nofollow">Show Source</a></li>
495
+ </ul>
496
+ </div>
497
+ <div id="searchbox" style="display: none" role="search">
498
+ <h3>Quick search</h3>
499
+ <form class="search" action="search.html" method="get">
500
+ <input type="text" name="q" />
501
+ <input type="submit" value="Go" />
502
+ <input type="hidden" name="check_keywords" value="yes" />
503
+ <input type="hidden" name="area" value="default" />
504
+ </form>
505
+ <p class="searchtip" style="font-size: 90%">
506
+ Enter search terms or a module, class or function name.
507
+ </p>
508
+ </div>
509
+ <script type="text/javascript">$('#searchbox').show(0);</script>
510
+ </div>
511
+ </div>
512
+ <div class="clearer"></div>
513
+ </div>
514
+ <div class="footer">
515
+ &copy;2016, StackPointCloud, Inc..
516
+
517
+ |
518
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
519
+ &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
520
+
521
+ |
522
+ <a href="_sources/monitoring_policies.txt"
523
+ rel="nofollow">Page source</a>
524
+ </div>
525
+
526
+
527
+
528
+
529
+ </body>
530
+ </html>