RubyGems - 1and1 - Versions diffs - 1.1 - Mend

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

checksums.yaml +7 -0
data/.gitignore +2 -0
data/1and1-1.0.gem +0 -0
data/1and1.gemspec +20 -0
data/Gemfile +4 -0
data/LICENSE +201 -0
data/README.md +499 -0
data/docs/reference.md +2447 -0
data/examples/dvd_examples.rb +15 -0
data/examples/example_app.rb +100 -0
data/examples/firewall_examples.rb +137 -0
data/examples/image_examples.rb +48 -0
data/examples/load_balancer_examples.rb +145 -0
data/examples/log_examples.rb +15 -0
data/examples/monitoring_center_examples.rb +15 -0
data/examples/monitoring_policy_examples.rb +343 -0
data/examples/private_network_examples.rb +86 -0
data/examples/public_ip_examples.rb +42 -0
data/examples/role_examples.rb +113 -0
data/examples/server_appliance_examples.rb +15 -0
data/examples/server_examples.rb +438 -0
data/examples/shared_storage_examples.rb +108 -0
data/examples/usage_examples.rb +6 -0
data/examples/user_examples.rb +113 -0
data/examples/vpn_examples.rb +56 -0
data/lib/1and1/datacenter.rb +73 -0
data/lib/1and1/dvd.rb +73 -0
data/lib/1and1/firewall.rb +427 -0
data/lib/1and1/image.rb +231 -0
data/lib/1and1/load_balancer.rb +448 -0
data/lib/1and1/log.rb +77 -0
data/lib/1and1/monitoring_center.rb +84 -0
data/lib/1and1/monitoring_policy.rb +598 -0
data/lib/1and1/oneandone.rb +57 -0
data/lib/1and1/ping.rb +41 -0
data/lib/1and1/ping_auth.rb +41 -0
data/lib/1and1/pricing.rb +41 -0
data/lib/1and1/private_network.rb +333 -0
data/lib/1and1/public_ip.rb +192 -0
data/lib/1and1/role.rb +381 -0
data/lib/1and1/server.rb +1208 -0
data/lib/1and1/server_appliance.rb +73 -0
data/lib/1and1/shared_storage.rb +379 -0
data/lib/1and1/usage.rb +58 -0
data/lib/1and1/user.rb +374 -0
data/lib/1and1/vpn.rb +249 -0
data/lib/oneandone.rb +27 -0
data/sphinx/Makefile +192 -0
data/sphinx/_build/doctrees/dvds.doctree +0 -0
data/sphinx/_build/doctrees/environment.pickle +0 -0
data/sphinx/_build/doctrees/firewalls.doctree +0 -0
data/sphinx/_build/doctrees/images.doctree +0 -0
data/sphinx/_build/doctrees/index.doctree +0 -0
data/sphinx/_build/doctrees/load_balancers.doctree +0 -0
data/sphinx/_build/doctrees/logs.doctree +0 -0
data/sphinx/_build/doctrees/monitoring_center.doctree +0 -0
data/sphinx/_build/doctrees/monitoring_policies.doctree +0 -0
data/sphinx/_build/doctrees/private_networks.doctree +0 -0
data/sphinx/_build/doctrees/public_ips.doctree +0 -0
data/sphinx/_build/doctrees/server_appliances.doctree +0 -0
data/sphinx/_build/doctrees/servers.doctree +0 -0
data/sphinx/_build/doctrees/shared_storages.doctree +0 -0
data/sphinx/_build/doctrees/usages.doctree +0 -0
data/sphinx/_build/doctrees/users.doctree +0 -0
data/sphinx/_build/html/.buildinfo +4 -0
data/sphinx/_build/html/_sources/dvds.txt +42 -0
data/sphinx/_build/html/_sources/firewalls.txt +189 -0
data/sphinx/_build/html/_sources/images.txt +101 -0
data/sphinx/_build/html/_sources/index.txt +499 -0
data/sphinx/_build/html/_sources/load_balancers.txt +231 -0
data/sphinx/_build/html/_sources/logs.txt +55 -0
data/sphinx/_build/html/_sources/monitoring_center.txt +55 -0
data/sphinx/_build/html/_sources/monitoring_policies.txt +288 -0
data/sphinx/_build/html/_sources/private_networks.txt +146 -0
data/sphinx/_build/html/_sources/public_ips.txt +78 -0
data/sphinx/_build/html/_sources/server_appliances.txt +42 -0
data/sphinx/_build/html/_sources/servers.txt +630 -0
data/sphinx/_build/html/_sources/shared_storages.txt +160 -0
data/sphinx/_build/html/_sources/usages.txt +45 -0
data/sphinx/_build/html/_sources/users.txt +172 -0
data/sphinx/_build/html/_static/ajax-loader.gif +0 -0
data/sphinx/_build/html/_static/alabaster.css +585 -0
data/sphinx/_build/html/_static/basic.css +599 -0
data/sphinx/_build/html/_static/comment-bright.png +0 -0
data/sphinx/_build/html/_static/comment-close.png +0 -0
data/sphinx/_build/html/_static/comment.png +0 -0
data/sphinx/_build/html/_static/doctools.js +263 -0
data/sphinx/_build/html/_static/down-pressed.png +0 -0
data/sphinx/_build/html/_static/down.png +0 -0
data/sphinx/_build/html/_static/file.png +0 -0
data/sphinx/_build/html/_static/jquery-1.11.1.js +10308 -0
data/sphinx/_build/html/_static/jquery.js +4 -0
data/sphinx/_build/html/_static/minus.png +0 -0
data/sphinx/_build/html/_static/plus.png +0 -0
data/sphinx/_build/html/_static/pygments.css +63 -0
data/sphinx/_build/html/_static/searchtools.js +651 -0
data/sphinx/_build/html/_static/underscore-1.3.1.js +999 -0
data/sphinx/_build/html/_static/underscore.js +31 -0
data/sphinx/_build/html/_static/up-pressed.png +0 -0
data/sphinx/_build/html/_static/up.png +0 -0
data/sphinx/_build/html/_static/websupport.js +808 -0
data/sphinx/_build/html/dvds.html +151 -0
data/sphinx/_build/html/firewalls.html +397 -0
data/sphinx/_build/html/genindex.html +114 -0
data/sphinx/_build/html/images.html +236 -0
data/sphinx/_build/html/index.html +571 -0
data/sphinx/_build/html/load_balancers.html +409 -0
data/sphinx/_build/html/logs.html +160 -0
data/sphinx/_build/html/monitoring_center.html +160 -0
data/sphinx/_build/html/monitoring_policies.html +530 -0
data/sphinx/_build/html/objects.inv +0 -0
data/sphinx/_build/html/private_networks.html +316 -0
data/sphinx/_build/html/public_ips.html +215 -0
data/sphinx/_build/html/rb-modindex.html +106 -0
data/sphinx/_build/html/search.html +99 -0
data/sphinx/_build/html/searchindex.js +1 -0
data/sphinx/_build/html/server_appliances.html +153 -0
data/sphinx/_build/html/servers.html +994 -0
data/sphinx/_build/html/shared_storages.html +349 -0
data/sphinx/_build/html/usages.html +140 -0
data/sphinx/_build/html/users.html +363 -0
data/sphinx/conf.py +287 -0
data/sphinx/dvds.rst +42 -0
data/sphinx/firewalls.rst +189 -0
data/sphinx/images.rst +101 -0
data/sphinx/index.rst +499 -0
data/sphinx/load_balancers.rst +231 -0
data/sphinx/logs.rst +55 -0
data/sphinx/make.bat +263 -0
data/sphinx/monitoring_center.rst +55 -0
data/sphinx/monitoring_policies.rst +288 -0
data/sphinx/private_networks.rst +146 -0
data/sphinx/public_ips.rst +78 -0
data/sphinx/server_appliances.rst +42 -0
data/sphinx/servers.rst +630 -0
data/sphinx/shared_storages.rst +160 -0
data/sphinx/usages.rst +45 -0
data/sphinx/users.rst +172 -0
data/test/mock-api/add-firewall.json +66 -0
data/test/mock-api/add-hdd.json +49 -0
data/test/mock-api/add-lb.json +71 -0
data/test/mock-api/add-new-ip.json +18 -0
data/test/mock-api/add-pn.json +66 -0
data/test/mock-api/add-port-mp.json +81 -0
data/test/mock-api/add-process-mp.json +20 -0
data/test/mock-api/add-rule-fp.json +33 -0
data/test/mock-api/add-rule-lb.json +40 -0
data/test/mock-api/add-server-ip.json +66 -0
data/test/mock-api/add-server-mp.json +66 -0
data/test/mock-api/assign-ip-fp.json +32 -0
data/test/mock-api/assign-server-lb.json +39 -0
data/test/mock-api/attach-server-pn.json +14 -0
data/test/mock-api/attach-server-storage.json +24 -0
data/test/mock-api/change-api-key.json +15 -0
data/test/mock-api/change-password.json +5 -0
data/test/mock-api/change-server-status.json +70 -0
data/test/mock-api/clone-server.json +29 -0
data/test/mock-api/create-fp.json +26 -0
data/test/mock-api/create-image.json +30 -0
data/test/mock-api/create-lb.json +33 -0
data/test/mock-api/create-mp.json +81 -0
data/test/mock-api/create-pn.json +11 -0
data/test/mock-api/create-public-ip.json +10 -0
data/test/mock-api/create-server.json +34 -0
data/test/mock-api/create-snapshot.json +74 -0
data/test/mock-api/create-storage.json +13 -0
data/test/mock-api/create-user.json +14 -0
data/test/mock-api/delete-fp.json +26 -0
data/test/mock-api/delete-image.json +26 -0
data/test/mock-api/delete-ip.json +15 -0
data/test/mock-api/delete-lb.json +33 -0
data/test/mock-api/delete-mp.json +71 -0
data/test/mock-api/delete-pn.json +11 -0
data/test/mock-api/delete-public-ip.json +10 -0
data/test/mock-api/delete-rule-fp.json +26 -0
data/test/mock-api/delete-server.json +50 -0
data/test/mock-api/delete-snapshot.json +74 -0
data/test/mock-api/delete-storage.json +24 -0
data/test/mock-api/delete-user.json +15 -0
data/test/mock-api/detach-server-lb.json +33 -0
data/test/mock-api/detach-server-mp.json +65 -0
data/test/mock-api/detach-server-storage.json +19 -0
data/test/mock-api/edit-image.json +26 -0
data/test/mock-api/eject-dvd.json +66 -0
data/test/mock-api/fixed-server-flavors.json +70 -0
data/test/mock-api/get-appliance.json +16 -0
data/test/mock-api/get-dvd.json +9 -0
data/test/mock-api/get-firewall.json +26 -0
data/test/mock-api/get-fixed-server.json +17 -0
data/test/mock-api/get-fp-rule.json +7 -0
data/test/mock-api/get-hardware.json +13 -0
data/test/mock-api/get-hdd.json +5 -0
data/test/mock-api/get-image.json +26 -0
data/test/mock-api/get-lb-rule.json +7 -0
data/test/mock-api/get-lb-server.json +5 -0
data/test/mock-api/get-load-balancer.json +33 -0
data/test/mock-api/get-log.json +23 -0
data/test/mock-api/get-monitoring-center.json +161 -0
data/test/mock-api/get-mp-port.json +7 -0
data/test/mock-api/get-mp-process.json +6 -0
data/test/mock-api/get-mp-server.json +4 -0
data/test/mock-api/get-mp.json +65 -0
data/test/mock-api/get-pn-server.json +4 -0
data/test/mock-api/get-private-network.json +20 -0
data/test/mock-api/get-public-ip.json +10 -0
data/test/mock-api/get-server-dvd.json +4 -0
data/test/mock-api/get-server-image.json +4 -0
data/test/mock-api/get-server-ip-fp.json +4 -0
data/test/mock-api/get-server-ip.json +8 -0
data/test/mock-api/get-server-pn.json +16 -0
data/test/mock-api/get-server-status.json +4 -0
data/test/mock-api/get-server-storage.json +5 -0
data/test/mock-api/get-server.json +44 -0
data/test/mock-api/get-storage.json +19 -0
data/test/mock-api/get-usage.json +161 -0
data/test/mock-api/get-user-api-key.json +3 -0
data/test/mock-api/get-user-api.json +7 -0
data/test/mock-api/get-user.json +15 -0
data/test/mock-api/list-appliances.json +66 -0
data/test/mock-api/list-credentials.json +5 -0
data/test/mock-api/list-dvds.json +128 -0
data/test/mock-api/list-firewalls.json +54 -0
data/test/mock-api/list-fp-rules.json +16 -0
data/test/mock-api/list-hdds.json +7 -0
data/test/mock-api/list-images.json +54 -0
data/test/mock-api/list-lb-rules.json +16 -0
data/test/mock-api/list-lb-servers.json +12 -0
data/test/mock-api/list-load-balancers.json +68 -0
data/test/mock-api/list-logs.json +49 -0
data/test/mock-api/list-monitoring-center-usages.json +90 -0
data/test/mock-api/list-mp-ports.json +16 -0
data/test/mock-api/list-mp-processes.json +14 -0
data/test/mock-api/list-mp-servers.json +10 -0
data/test/mock-api/list-mps.json +152 -0
data/test/mock-api/list-pn-servers.json +10 -0
data/test/mock-api/list-private-networks.json +24 -0
data/test/mock-api/list-public-ips.json +44 -0
data/test/mock-api/list-server-fps.json +4 -0
data/test/mock-api/list-server-ips-fp.json +7 -0
data/test/mock-api/list-server-ips.json +10 -0
data/test/mock-api/list-server-lbs.json +6 -0
data/test/mock-api/list-server-pns.json +6 -0
data/test/mock-api/list-servers.json +66 -0
data/test/mock-api/list-snapshots.json +7 -0
data/test/mock-api/list-storages.json +47 -0
data/test/mock-api/list-usages.json +144 -0
data/test/mock-api/list-user-ips.json +5 -0
data/test/mock-api/list-users.json +31 -0
data/test/mock-api/load-dvd.json +63 -0
data/test/mock-api/modify-fp.json +26 -0
data/test/mock-api/modify-lb.json +33 -0
data/test/mock-api/modify-mp.json +81 -0
data/test/mock-api/modify-pn.json +20 -0
data/test/mock-api/modify-port-mp.json +81 -0
data/test/mock-api/modify-process-mp.json +73 -0
data/test/mock-api/modify-public-ip.json +10 -0
data/test/mock-api/modify-server-hardware.json +44 -0
data/test/mock-api/modify-server-hdd.json +54 -0
data/test/mock-api/modify-server.json +44 -0
data/test/mock-api/modify-storage.json +19 -0
data/test/mock-api/modify-user-api.json +15 -0
data/test/mock-api/modify-user.json +15 -0
data/test/mock-api/reinstall-image.json +52 -0
data/test/mock-api/remove-firewall-policy.json +26 -0
data/test/mock-api/remove-hdd.json +54 -0
data/test/mock-api/remove-ip-fp.json +26 -0
data/test/mock-api/remove-lb.json +66 -0
data/test/mock-api/remove-pn.json +71 -0
data/test/mock-api/remove-port-mp.json +73 -0
data/test/mock-api/remove-process-mp.json +66 -0
data/test/mock-api/remove-rule-lb.json +33 -0
data/test/mock-api/remove-server-ip.json +58 -0
data/test/mock-api/remove-server-pn.json +16 -0
data/test/mock-api/restore-snapshot.json +55 -0
data/test/mock-api/storage-servers.json +12 -0
data/test/test_mock_dvd.rb +55 -0
data/test/test_mock_firewall.rb +309 -0
data/test/test_mock_image.rb +123 -0
data/test/test_mock_load_balancer.rb +312 -0
data/test/test_mock_log.rb +55 -0
data/test/test_mock_monitoring_center.rb +55 -0
data/test/test_mock_monitoring_policy.rb +587 -0
data/test/test_mock_private_network.rb +206 -0
data/test/test_mock_public_ip.rb +118 -0
data/test/test_mock_server.rb +929 -0
data/test/test_mock_server_appliance.rb +55 -0
data/test/test_mock_shared_storage.rb +256 -0
data/test/test_mock_usage.rb +34 -0
data/test/test_mock_user.rb +270 -0
metadata +360 -0

data/sphinx/_build/html/monitoring_center.html ADDED

@@ -0,0 +1,160 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>Monitoring Center &mdash; 1and1 Ruby SDK 1.0 documentation</title>
+    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '1.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
+    <link rel="next" title="Monitoring Policies" href="monitoring_policies.html" />
+    <link rel="prev" title="Private Networks" href="private_networks.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+  </head>
+  <body role="document">
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <div class="section" id="monitoring-center">
+<h1>Monitoring Center<a class="headerlink" href="#monitoring-center" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt>
+<code class="descname">OneAndOne::MonitoringCenter()</code></dt>
+<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>
+<dl class="method">
+<dt id="list">
+<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>
+<dd><p>List all usages and alerts of monitoring servers.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) &#8211; Number of items per page.</li>
+<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
+alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
+sorted by their creation date in descending order.</li>
+<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
+that match your search query.</li>
+<li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; Returns only the parameters requested.
+(i.e. fields: &#8216;id, name, description, hardware.ram&#8217;)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="get">
+<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>
+<dd><p>Returns the usage of the resources for the specified time range.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the server.</li>
+<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
+<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>,
+<code class="docutils literal"><span class="pre">'LAST_365D'</span></code>, or <code class="docutils literal"><span class="pre">'CUSTOM'</span></code></li>
+<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
+<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>
+<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
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+</dd></dl>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="private_networks.html" title="previous chapter">Private Networks</a></li>
+      <li>Next: <a href="monitoring_policies.html" title="next chapter">Monitoring Policies</a></li>
+  </ul></li>
+</ul>
+</div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/monitoring_center.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2016, StackPointCloud, Inc..
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
+      |
+      <a href="_sources/monitoring_center.txt"
+          rel="nofollow">Page source</a>
+    </div>
+  </body>
+</html>

data/sphinx/_build/html/monitoring_policies.html ADDED

@@ -0,0 +1,530 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>Monitoring Policies &mdash; 1and1 Ruby SDK 1.0 documentation</title>
+    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '1.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
+    <link rel="next" title="Logs" href="logs.html" />
+    <link rel="prev" title="Monitoring Center" href="monitoring_center.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+  </head>
+  <body role="document">
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <div class="section" id="monitoring-policies">
+<h1>Monitoring Policies<a class="headerlink" href="#monitoring-policies" title="Permalink to this headline">¶</a></h1>
+<dl class="class">
+<dt>
+<code class="descname">OneAndOne::MonitoringPolicy()</code></dt>
+<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>
+<dl class="method">
+<dt id="list">
+<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>
+<dd><p>Return a list of all monitoring policies.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) &#8211; Number of items per page.</li>
+<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
+alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
+sorted by their creation date in descending order.</li>
+<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
+that match your search query.</li>
+<li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; Returns only the parameters requested.
+(i.e. fields: &#8216;id, name, description, hardware.ram&#8217;)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="create">
+<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>
+<dd><p>Create a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy name.</li>
+<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy description.</li>
+<li><strong>email</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; user&#8217;s email.</li>
+<li><strong>agent</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) &#8211; set true for using agent.</li>
+<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>
+<li><strong>ports</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;port hashes&#8221;.</li>
+<li><strong>processes</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;process hashes&#8221;.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="get">
+<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>
+<dd><p>Returns a monitoring policy&#8217;s current specs.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="modify">
+<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>
+<dd><p>Modify a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy name.</li>
+<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; monitoring policy description.</li>
+<li><strong>email</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; user&#8217;s email.</li>
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="delete">
+<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>
+<dd><p>Delete a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="ports">
+<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>
+<dd><p>List a monitoring policy&#8217;s ports.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="add_ports">
+<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>
+<dd><p>Add ports to a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>ports</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;port hashes&#8221;.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="port">
+<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>
+<dd><p>Returns information about a monitoring policy&#8217;s port.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>port_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the port.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="modify_port">
+<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>
+<dd><p>Modify a monitoring policy&#8217;s port.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>port_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the port.</li>
+<li><strong>new_port</strong> (<code class="docutils literal"><span class="pre">hash</span></code>) &#8211; takes a &#8220;port hash&#8221;,</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="delete_port">
+<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>
+<dd><p>Delete a monitoring policy&#8217;s port.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>port_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the port.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="processes">
+<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>
+<dd><p>List a monitoring policy&#8217;s processes.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="process">
+<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>
+<dd><p>Returns information about a monitoring policy&#8217;s process.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>process_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the process.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="add_processes">
+<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>
+<dd><p>Add processes to a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>processes</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of &#8220;process hashes&#8221;.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="modify_process">
+<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>
+<dd><p>Modify a monitoring policy&#8217;s process.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>process_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the process.</li>
+<li><strong>new_process</strong> (<code class="docutils literal"><span class="pre">hash</span></code>) &#8211; takes a &#8220;process hash&#8221;,</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="delete_process">
+<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>
+<dd><p>Delete a monitoring policy&#8217;s process.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>process_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the process.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="servers">
+<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>
+<dd><p>List a monitoring policy&#8217;s servers.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="server">
+<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>
+<dd><p>Returns information about a monitoring policy&#8217;s server.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the server.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="add_servers">
+<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>
+<dd><p>Add servers to a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>servers</strong> (<code class="docutils literal"><span class="pre">array</span></code>) &#8211; an array of server ID strings.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="remove_server">
+<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>
+<dd><p>Remove a server from a monitoring policy.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<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>
+<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) &#8211; the unique identifier for the server.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="wait_for">
+<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>
+<dd><p>Polls the monitoring policy until an &#8220;ACTIVE&#8221; state is returned.  Use this when chaining actions.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<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>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+</dd></dl>
+</div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="monitoring_center.html" title="previous chapter">Monitoring Center</a></li>
+      <li>Next: <a href="logs.html" title="next chapter">Logs</a></li>
+  </ul></li>
+</ul>
+</div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/monitoring_policies.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2016, StackPointCloud, Inc..
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
+      |
+      <a href="_sources/monitoring_policies.txt"
+          rel="nofollow">Page source</a>
+    </div>
+  </body>
+</html>