1and1 1.1
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -0,0 +1,106 @@
|
|
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>Ruby Module Index — 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
|
+
|
28
|
+
|
29
|
+
|
30
|
+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
31
|
+
|
32
|
+
|
33
|
+
<script type="text/javascript">
|
34
|
+
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
|
35
|
+
</script>
|
36
|
+
|
37
|
+
|
38
|
+
</head>
|
39
|
+
<body role="document">
|
40
|
+
|
41
|
+
<div class="document">
|
42
|
+
<div class="documentwrapper">
|
43
|
+
<div class="bodywrapper">
|
44
|
+
<div class="body" role="main">
|
45
|
+
|
46
|
+
|
47
|
+
<h1>Ruby Module Index</h1>
|
48
|
+
|
49
|
+
<div class="modindex-jumpbox">
|
50
|
+
<a href="#cap-o"><strong>o</strong></a>
|
51
|
+
</div>
|
52
|
+
|
53
|
+
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
|
54
|
+
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
55
|
+
<tr class="cap" id="cap-o"><td></td><td>
|
56
|
+
<strong>o</strong></td><td></td></tr>
|
57
|
+
<tr>
|
58
|
+
<td></td>
|
59
|
+
<td>
|
60
|
+
<a href="index.html#module-OneAndOne"><code class="xref">OneAndOne</code></a></td><td>
|
61
|
+
<em></em></td></tr>
|
62
|
+
</table>
|
63
|
+
|
64
|
+
|
65
|
+
</div>
|
66
|
+
</div>
|
67
|
+
</div>
|
68
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
69
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
70
|
+
<h3>Related Topics</h3>
|
71
|
+
<ul>
|
72
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
73
|
+
</ul></li>
|
74
|
+
</ul>
|
75
|
+
</div>
|
76
|
+
<div id="searchbox" style="display: none" role="search">
|
77
|
+
<h3>Quick search</h3>
|
78
|
+
<form class="search" action="search.html" method="get">
|
79
|
+
<input type="text" name="q" />
|
80
|
+
<input type="submit" value="Go" />
|
81
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
82
|
+
<input type="hidden" name="area" value="default" />
|
83
|
+
</form>
|
84
|
+
<p class="searchtip" style="font-size: 90%">
|
85
|
+
Enter search terms or a module, class or function name.
|
86
|
+
</p>
|
87
|
+
</div>
|
88
|
+
<script type="text/javascript">$('#searchbox').show(0);</script>
|
89
|
+
</div>
|
90
|
+
</div>
|
91
|
+
<div class="clearer"></div>
|
92
|
+
</div>
|
93
|
+
<div class="footer">
|
94
|
+
©2016, StackPointCloud, Inc..
|
95
|
+
|
96
|
+
|
|
97
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
98
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
</body>
|
106
|
+
</html>
|
@@ -0,0 +1,99 @@
|
|
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>Search — 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
|
+
<script type="text/javascript" src="_static/searchtools.js"></script>
|
27
|
+
<link rel="top" title="1and1 Ruby SDK 1.0 documentation" href="index.html" />
|
28
|
+
<script type="text/javascript">
|
29
|
+
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
30
|
+
</script>
|
31
|
+
|
32
|
+
<script type="text/javascript" id="searchindexloader"></script>
|
33
|
+
|
34
|
+
|
35
|
+
|
36
|
+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
37
|
+
|
38
|
+
|
39
|
+
</head>
|
40
|
+
<body role="document">
|
41
|
+
|
42
|
+
<div class="document">
|
43
|
+
<div class="documentwrapper">
|
44
|
+
<div class="bodywrapper">
|
45
|
+
<div class="body" role="main">
|
46
|
+
|
47
|
+
<h1 id="search-documentation">Search</h1>
|
48
|
+
<div id="fallback" class="admonition warning">
|
49
|
+
<script type="text/javascript">$('#fallback').hide();</script>
|
50
|
+
<p>
|
51
|
+
Please activate JavaScript to enable the search
|
52
|
+
functionality.
|
53
|
+
</p>
|
54
|
+
</div>
|
55
|
+
<p>
|
56
|
+
From here you can search these documents. Enter your search
|
57
|
+
words into the box below and click "search". Note that the search
|
58
|
+
function will automatically search for all of the words. Pages
|
59
|
+
containing fewer words won't appear in the result list.
|
60
|
+
</p>
|
61
|
+
<form action="" method="get">
|
62
|
+
<input type="text" name="q" value="" />
|
63
|
+
<input type="submit" value="search" />
|
64
|
+
<span id="search-progress" style="padding-left: 10px"></span>
|
65
|
+
</form>
|
66
|
+
|
67
|
+
<div id="search-results">
|
68
|
+
|
69
|
+
</div>
|
70
|
+
|
71
|
+
</div>
|
72
|
+
</div>
|
73
|
+
</div>
|
74
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
75
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
76
|
+
<h3>Related Topics</h3>
|
77
|
+
<ul>
|
78
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
79
|
+
</ul></li>
|
80
|
+
</ul>
|
81
|
+
</div>
|
82
|
+
</div>
|
83
|
+
</div>
|
84
|
+
<div class="clearer"></div>
|
85
|
+
</div>
|
86
|
+
<div class="footer">
|
87
|
+
©2016, StackPointCloud, Inc..
|
88
|
+
|
89
|
+
|
|
90
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
91
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
92
|
+
|
93
|
+
</div>
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
</body>
|
99
|
+
</html>
|
@@ -0,0 +1 @@
|
|
1
|
+
Search.setIndex({envversion:46,filenames:["dvds","firewalls","images","index","load_balancers","logs","monitoring_center","monitoring_policies","private_networks","public_ips","server_appliances","servers","shared_storages","usages","users"],objects:{"":{"delete":[14,1,1,""],OneAndOne:[3,0,0,"-"],access:[12,1,1,""],add_firewall:[11,1,1,""],add_hdds:[11,1,1,""],add_ip:[11,1,1,""],add_ips:[14,1,1,""],add_load_balancer:[11,1,1,""],add_ports:[7,1,1,""],add_private_network:[11,1,1,""],add_processes:[7,1,1,""],add_rules:[4,1,1,""],add_servers:[12,1,1,""],api:[14,1,1,""],api_key:[14,1,1,""],change_key:[14,1,1,""],change_password:[12,1,1,""],change_status:[11,1,1,""],clone:[11,1,1,""],create:[14,1,1,""],create_snapshot:[11,1,1,""],delete_hdd:[11,1,1,""],delete_port:[7,1,1,""],delete_process:[7,1,1,""],delete_snapshot:[11,1,1,""],dvd:[11,1,1,""],eject_dvd:[11,1,1,""],enable_api:[14,1,1,""],firewall:[11,1,1,""],get:[14,1,1,""],get_fixed:[11,1,1,""],get_hdd:[11,1,1,""],hardware:[11,1,1,""],hdds:[11,1,1,""],image:[11,1,1,""],install_image:[11,1,1,""],ip:[11,1,1,""],ips:[14,1,1,""],list:[14,1,1,""],list_fixed:[11,1,1,""],load_balancers:[11,1,1,""],load_dvd:[11,1,1,""],modify:[14,1,1,""],modify_hardware:[11,1,1,""],modify_hdd:[11,1,1,""],modify_port:[7,1,1,""],modify_process:[7,1,1,""],port:[7,1,1,""],ports:[7,1,1,""],private_network:[11,1,1,""],private_networks:[11,1,1,""],process:[7,1,1,""],processes:[7,1,1,""],release_ip:[11,1,1,""],remove_firewall:[11,1,1,""],remove_ip:[14,1,1,""],remove_load_balancer:[11,1,1,""],remove_private_network:[11,1,1,""],remove_rule:[4,1,1,""],remove_server:[12,1,1,""],restore_snapshot:[11,1,1,""],rule:[4,1,1,""],rules:[4,1,1,""],server:[12,1,1,""],servers:[12,1,1,""],snapshot:[11,1,1,""],status:[11,1,1,""],wait_for:[12,1,1,""]}},objnames:{"0":["rb","module","Ruby module"],"1":["rb","method","Ruby method"]},objtypes:{"0":"rb:module","1":"rb:method"},terms:{"00z":[5,6,13],"05t00":[5,6,13],"1and1":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],"class":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],"default":11,"int":[0,1,2,4,5,6,7,8,9,10,11,12,13,14],"new":[1,2,3,11,12,14],"public":3,"return":[0,1,2,4,5,6,7,8,9,10,11,12,13,14],"true":[3,7,11],about:[0,1,4,5,7,8,10,11,12],access:[3,12,14],account:[0,3,14],action:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],activ:[1,2,4,7,8,11,12,14],add:[1,3,4,7,8,11,12,14],add_firewal:[3,11],add_hdd:11,add_ip:[1,3,4,11,14],add_load_balanc:[3,11],add_port:7,add_private_network:11,add_process:7,add_rul:[1,4],add_serv:[3,7,8,12],addit:11,address:[3,8],after:11,against:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],agent:[3,7],alert:[3,6],alert_if:3,all:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],allow:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],alphabet:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],also:3,amount:11,ani:3,api:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],api_kei:14,appli:3,applianc:3,appliance_id:[3,10,11],applic:3,arrai:[1,4,7,8,11,12,14],assign:[1,4,11],avail:[3,11],befor:3,begin:3,below:3,between:4,bool:[4,7,11,14],call:[3,4],can:[2,3,4,9,14],cannot:11,center:3,chain:[1,2,3,4,7,8,11,12],chang:[2,3,12,14],change_kei:14,change_password:12,change_statu:11,check:4,choos:11,clean:3,cleanup:3,click:3,client:3,clone:11,code:3,cold:11,com:3,common:3,configur:11,contain:14,control:3,copi:2,cores_per_processor:[3,11],cost:3,cpu:[3,7],creat:[1,2],create_snapshot:11,creation:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],creation_d:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],credenti:[3,12,14],critic:[3,7],current:[1,2,4,7,8,9,11,12,14],custom:[5,6,13],daili:2,date:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],decreas:11,delet:[1,2,3,4,7,8,9,11,12,14],delete_hdd:11,delete_port:7,delete_process:7,delete_snapshot:11,deploi:3,desc:3,descend:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],descript:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],desir:[3,11],detail:3,directli:3,disabl:[3,4,14],displai:3,document:3,done:3,dure:3,dvd_id:[0,11],dynam:3,each:3,eject:11,eject_dvd:11,element:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],email:[3,7,14],email_notif:3,enabl:[4,14],enable_api:14,end:[5,6,13],end_dat:[5,6,13],enter:3,everyth:3,express:4,fals:[3,11],field:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],firewall_id:[1,3,11],fix:11,fixed_instance_id:11,flavor:11,follow:[3,11],format:[5,6,13],fp1:3,frequenc:2,from:[1,3,4,7,8,11,12,14],gem:3,get:[0,1,2],get_fix:11,get_hdd:11,github:3,given:8,good:3,guid:3,hardwar:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],hash:[7,12],have:3,hdd1:3,hdd:[3,11],hdd_id:[3,11],health:4,health_check_interv:[3,4],health_check_pars:4,health_check_path:4,health_check_test:[3,4],hot:11,how:3,http:[3,4],identifi:[0,1,2,4,5,6,7,8,9,10,11,12,14],illustr:3,image_id:[2,11],increas:3,independ:3,indic:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],inform:[0,1,3,4,5,7,8,10,11,12],init:3,install_imag:11,instanc:[3,11],instanti:3,instruct:3,interact:3,internal_p:[3,7],internet:3,ip_id:[1,3,4,9,11],ip_typ:11,ipv4:[9,11],is_main:3,item:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],json:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],just:3,keep:[3,11],keep_ip:11,kei:[3,14],last_24h:[5,6,13],last_30d:[5,6,13],last_365d:[5,6,13],last_7d:[5,6,13],last_hour:[5,6,13],latest:3,lb1:3,least:14,least_connect:4,let:3,lib:3,librari:3,limit:[3,7],line:3,list:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],list_fix:11,load_balanc:[3,11],load_balancer_id:[3,4,11],load_dvd:11,loadbalanc:[3,4],log:3,log_id:5,look:3,made:3,mail:3,manag:3,mask:8,match:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],mess:3,method:[3,4,11],modifi:[1,2,4,7,8,9,11,12,14],modify_hardwar:[3,11],modify_hdd:[3,11],modify_port:7,modify_process:7,modul:3,moment:11,monitoring_polici:3,monitoring_policy_id:[7,11],monitoringcent:6,monitoringpolici:[3,7],multipl:[3,11,12],must:[11,12],name:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],need:3,network:3,network_address:8,new_ip:3,new_port:7,new_process:7,next:3,nil:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],none:4,not_respond:3,not_run:3,now:3,num_imag:2,number:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],object:[1,3,4],offici:3,onc:2,oneandon:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],onli:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],onto:11,oper:3,option:11,order:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],other:3,outlin:3,over:3,page:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],pagin:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],panel:3,paramet:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],password:[3,11,12,14],per:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],per_pag:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],perform:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],period:[4,5,6,13],perman:11,persist:[3,4],persistence_tim:[3,4],persistnec:4,platform:3,point:[5,6,13],poll:[1,2,4,7,8,11,12],port1:3,port:[3,7],port_balanc:3,port_from:3,port_id:7,port_serv:3,port_to:3,possibl:[2,4,5,6,11,13,14],power_off:11,power_on:11,powered_off:11,powered_on:11,pretty_gener:3,privat:3,private_network:11,private_network_id:[8,11],privatenetwork:8,procedur:4,process1:3,process:[3,7],process_id:7,processor:11,programmat:3,protocol:3,publicip:9,put:3,queri:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],ram:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],rang:[4,5,6,13],reboot:11,receiv:3,regular:4,releas:11,release_ip:11,remov:[1,3,4,7,8,11,12,14],remove_firewal:11,remove_ip:[1,4,14],remove_load_balanc:11,remove_private_network:11,remove_rul:[1,4],remove_serv:[7,8,12],repeat:3,repo:3,request:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],requir:[3,4,5,6,11,13],require_rel:3,resiz:11,respons:3,rest:3,restor:11,restore_snapshot:11,restrict:3,retriev:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],revers:9,reverse_dn:9,round_robin:[3,4],rule1:3,rule:[1,3,4],rule_id:[1,4],run:3,search:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],second:4,section:3,select:3,send:3,server1:3,server2:3,server:2,server_id:[2,3,6,7,8,11,12],serverappli:10,set:[7,9,11],setup:3,share:[1,3],shared_storage_id:12,sharedstorag:12,show:3,shown:[5,6,13],sign:3,simpl:3,simpli:3,size:[3,11,12],smaller:11,snapshot:11,snapshot_id:11,softwar:11,some:3,sort:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],sourc:3,spec:[1,2,4,7,8,9,11,12,14],specifi:6,ssl:3,stabl:3,start:[0,1,2],start_dat:[5,6,13],state:[1,2,4,7,8,11,12,14],statu:11,storag:[1,3],str:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],string:[4,7,8,14],subnet:8,subnet_mask:8,success:3,support:11,take:[3,4,7,11],task:3,tcp:[3,4],test:3,than:11,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],threshold:[3,7],through:3,time:[3,4,5,6,9,13],togeth:3,token:3,total:11,transfer:[3,7],two:3,type:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],uniqu:[0,1,2,4,5,6,7,8,9,10,11,12,14],until:[1,2,4,7,8,11,12],upgrad:3,url:4,usag:[3,6],user:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],user_id:14,valid:8,valu:[2,3,4,5,6,11,13,14],vcore:[3,11],version:3,virtual:11,wait:3,wait_for:[1,2,3,4,7,8,11,12],want:11,warn:[3,7],weekli:2,when:[1,2,4,7,8,11,12],whether:11,which:[0,1,2,4,5,6,7,8,9,10,11,12,13,14],within:3,without:11,would:3,wrap:3,yet:3,you:[3,11,14],your:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14]},titles:["DVD’s","Firewall Policies","Images","1&1’s Ruby SDK","Load Balancers","Logs","Monitoring Center","Monitoring Policies","Private Networks","Public IPs","Server Appliances","Servers","Shared Storages","Usages","Users"],titleterms:{"public":9,app:3,applianc:10,authent:3,balanc:[3,4],center:6,concept:3,content:3,core:3,creat:3,disk:3,dvd:0,exampl:3,firewal:[1,3],get:3,imag:2,index:3,instal:3,load:[3,4],log:5,memori:3,monitor:[3,6,7],network:8,polici:[1,3,7],privat:8,resourc:3,rubi:3,sdk:3,server:[3,10,11],share:12,start:3,storag:12,tabl:3,updat:3,usag:13,user:14}})
|
@@ -0,0 +1,153 @@
|
|
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>Server Appliances — 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="DVD’s" href="dvds.html" />
|
28
|
+
<link rel="prev" title="Usages" href="usages.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="server-appliances">
|
42
|
+
<h1>Server Appliances<a class="headerlink" href="#server-appliances" title="Permalink to this headline">¶</a></h1>
|
43
|
+
<dl class="class">
|
44
|
+
<dt>
|
45
|
+
<code class="descname">OneAndOne::ServerAppliance()</code></dt>
|
46
|
+
<dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">ServerAppliance</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 server appliances.</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>) – 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>) – Number of items per page.</li>
|
58
|
+
<li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <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>) – <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>) – Returns only the parameters requested.
|
64
|
+
(i.e. fields: ‘id, name, description, hardware.ram’)</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>appliance_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
|
78
|
+
<dd><p>Returns information about an appliance.</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>appliance_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the appliance.</li>
|
85
|
+
</ul>
|
86
|
+
</td>
|
87
|
+
</tr>
|
88
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
89
|
+
</td>
|
90
|
+
</tr>
|
91
|
+
</tbody>
|
92
|
+
</table>
|
93
|
+
</dd></dl>
|
94
|
+
|
95
|
+
</dd></dl>
|
96
|
+
|
97
|
+
</div>
|
98
|
+
|
99
|
+
|
100
|
+
</div>
|
101
|
+
</div>
|
102
|
+
</div>
|
103
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
104
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
105
|
+
<h3>Related Topics</h3>
|
106
|
+
<ul>
|
107
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
108
|
+
<li>Previous: <a href="usages.html" title="previous chapter">Usages</a></li>
|
109
|
+
<li>Next: <a href="dvds.html" title="next chapter">DVD’s</a></li>
|
110
|
+
</ul></li>
|
111
|
+
</ul>
|
112
|
+
</div>
|
113
|
+
<div role="note" aria-label="source link">
|
114
|
+
<h3>This Page</h3>
|
115
|
+
<ul class="this-page-menu">
|
116
|
+
<li><a href="_sources/server_appliances.txt"
|
117
|
+
rel="nofollow">Show Source</a></li>
|
118
|
+
</ul>
|
119
|
+
</div>
|
120
|
+
<div id="searchbox" style="display: none" role="search">
|
121
|
+
<h3>Quick search</h3>
|
122
|
+
<form class="search" action="search.html" method="get">
|
123
|
+
<input type="text" name="q" />
|
124
|
+
<input type="submit" value="Go" />
|
125
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
126
|
+
<input type="hidden" name="area" value="default" />
|
127
|
+
</form>
|
128
|
+
<p class="searchtip" style="font-size: 90%">
|
129
|
+
Enter search terms or a module, class or function name.
|
130
|
+
</p>
|
131
|
+
</div>
|
132
|
+
<script type="text/javascript">$('#searchbox').show(0);</script>
|
133
|
+
</div>
|
134
|
+
</div>
|
135
|
+
<div class="clearer"></div>
|
136
|
+
</div>
|
137
|
+
<div class="footer">
|
138
|
+
©2016, StackPointCloud, Inc..
|
139
|
+
|
140
|
+
|
|
141
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
142
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
143
|
+
|
144
|
+
|
|
145
|
+
<a href="_sources/server_appliances.txt"
|
146
|
+
rel="nofollow">Page source</a>
|
147
|
+
</div>
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
</body>
|
153
|
+
</html>
|
@@ -0,0 +1,994 @@
|
|
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>Servers — 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="Images" href="images.html" />
|
28
|
+
<link rel="prev" title="1&1’s Ruby SDK" href="index.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="servers">
|
42
|
+
<h1>Servers<a class="headerlink" href="#servers" title="Permalink to this headline">¶</a></h1>
|
43
|
+
<dl class="class">
|
44
|
+
<dt>
|
45
|
+
<code class="descname">OneAndOne::Server()</code></dt>
|
46
|
+
<dd><p>The <code class="xref rb rb-class docutils literal"><span class="pre">Server</span></code> class allows a user to perform actions against the 1and1 API.</p>
|
47
|
+
<blockquote>
|
48
|
+
<div><dl class="method">
|
49
|
+
<dt id="list">
|
50
|
+
<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>
|
51
|
+
<dd><p>Return a list of all images.</p>
|
52
|
+
<table class="docutils field-list" frame="void" rules="none">
|
53
|
+
<col class="field-name" />
|
54
|
+
<col class="field-body" />
|
55
|
+
<tbody valign="top">
|
56
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
57
|
+
<li><strong>page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Allows the use of pagination. Indicate which page to start on.</li>
|
58
|
+
<li><strong>per_page</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Number of items per page.</li>
|
59
|
+
<li><strong>sort</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'name'</span></code> retrieves a list of elements sorted
|
60
|
+
alphabetically. <code class="docutils literal"><span class="pre">sort:</span> <span class="pre">'creation_date'</span></code> retrieves a list of elements
|
61
|
+
sorted by their creation date in descending order.</li>
|
62
|
+
<li><strong>q</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – <code class="docutils literal"><span class="pre">q</span></code> is for query. Use this parameter to return only the items
|
63
|
+
that match your search query.</li>
|
64
|
+
<li><strong>fields</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – Returns only the parameters requested.
|
65
|
+
(i.e. fields: ‘id, name, description, hardware.ram’)</li>
|
66
|
+
</ul>
|
67
|
+
</td>
|
68
|
+
</tr>
|
69
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
70
|
+
</td>
|
71
|
+
</tr>
|
72
|
+
</tbody>
|
73
|
+
</table>
|
74
|
+
</dd></dl>
|
75
|
+
|
76
|
+
<dl class="method">
|
77
|
+
<dt id="create">
|
78
|
+
<code class="descname">create</code><span class="sig-paren">(</span><em>name: nil</em>, <em>description: nil</em>, <em>fixed_instance_id: nil</em>, <em>vcore: nil</em>, <em>cores_per_processor: nil</em>, <em>ram: nil</em>, <em>appliance_id: nil</em>, <em>hdds: nil</em>, <em>password: nil</em>, <em>power_on: nil</em>, <em>firewall_id: nil</em>, <em>ip_id: nil</em>, <em>load_balancer_id: nil</em>, <em>monitoring_policy_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#create" title="Permalink to this definition">¶</a></dt>
|
79
|
+
<dd><p>Create a server.</p>
|
80
|
+
<div class="admonition note">
|
81
|
+
<p class="first admonition-title">Note</p>
|
82
|
+
<p>Only the following parameters are <strong>required</strong> to create a server:</p>
|
83
|
+
<ul class="last simple">
|
84
|
+
<li><code class="docutils literal"><span class="pre">name</span></code></li>
|
85
|
+
<li><code class="docutils literal"><span class="pre">description</span></code></li>
|
86
|
+
<li><code class="docutils literal"><span class="pre">vcore</span></code></li>
|
87
|
+
<li><code class="docutils literal"><span class="pre">cores_per_processor</span></code></li>
|
88
|
+
<li><code class="docutils literal"><span class="pre">ram</span></code></li>
|
89
|
+
<li><code class="docutils literal"><span class="pre">appliance_id</span></code></li>
|
90
|
+
</ul>
|
91
|
+
</div>
|
92
|
+
<div class="admonition note">
|
93
|
+
<p class="first admonition-title">Note</p>
|
94
|
+
<p class="last">Your HDD’s size must be a multiple of <code class="docutils literal"><span class="pre">20</span></code>.</p>
|
95
|
+
</div>
|
96
|
+
<table class="docutils field-list" frame="void" rules="none">
|
97
|
+
<col class="field-name" />
|
98
|
+
<col class="field-body" />
|
99
|
+
<tbody valign="top">
|
100
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
101
|
+
<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – server name.</li>
|
102
|
+
<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – server description.</li>
|
103
|
+
<li><strong>fixed_instance_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for your desired fixed server flavor.</li>
|
104
|
+
<li><strong>vcore</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Total amount of virtual cores.</li>
|
105
|
+
<li><strong>cores_per_processor</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Number of cores per processor.</li>
|
106
|
+
<li><strong>ram</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Memory size.</li>
|
107
|
+
<li><strong>appliance_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – image to be installed on the server.</li>
|
108
|
+
<li><strong>hdds</strong> (<code class="docutils literal"><span class="pre">array</span></code>) – takes an array of HDD’s.</li>
|
109
|
+
<li><strong>password</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – server password.</li>
|
110
|
+
<li><strong>power_on</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) – choose whether or not you want the server to ‘POWER_ON’ after creation. (True by default)</li>
|
111
|
+
<li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the firewall policy to be assigned.</li>
|
112
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the IP to be assigned.</li>
|
113
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer to be assigned.</li>
|
114
|
+
<li><strong>monitoring_policy_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the monitoring policy to be assigned.</li>
|
115
|
+
</ul>
|
116
|
+
</td>
|
117
|
+
</tr>
|
118
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
119
|
+
</td>
|
120
|
+
</tr>
|
121
|
+
</tbody>
|
122
|
+
</table>
|
123
|
+
</dd></dl>
|
124
|
+
|
125
|
+
<dl class="method">
|
126
|
+
<dt id="list_fixed">
|
127
|
+
<code class="descname">list_fixed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#list_fixed" title="Permalink to this definition">¶</a></dt>
|
128
|
+
<dd><p>Returns a list of available fixed server options.</p>
|
129
|
+
<table class="docutils field-list" frame="void" rules="none">
|
130
|
+
<col class="field-name" />
|
131
|
+
<col class="field-body" />
|
132
|
+
<tbody valign="top">
|
133
|
+
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">JSON</td>
|
134
|
+
</tr>
|
135
|
+
</tbody>
|
136
|
+
</table>
|
137
|
+
</dd></dl>
|
138
|
+
|
139
|
+
<dl class="method">
|
140
|
+
<dt id="get_fixed">
|
141
|
+
<code class="descname">get_fixed</code><span class="sig-paren">(</span><em>fixed_instance_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#get_fixed" title="Permalink to this definition">¶</a></dt>
|
142
|
+
<dd><p>Retrieve information about a fixed server option.</p>
|
143
|
+
<table class="docutils field-list" frame="void" rules="none">
|
144
|
+
<col class="field-name" />
|
145
|
+
<col class="field-body" />
|
146
|
+
<tbody valign="top">
|
147
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
148
|
+
<li><strong>fixed_instance_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the fixed server option.</li>
|
149
|
+
</ul>
|
150
|
+
</td>
|
151
|
+
</tr>
|
152
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
153
|
+
</td>
|
154
|
+
</tr>
|
155
|
+
</tbody>
|
156
|
+
</table>
|
157
|
+
</dd></dl>
|
158
|
+
|
159
|
+
<dl class="method">
|
160
|
+
<dt id="get">
|
161
|
+
<code class="descname">get</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#get" title="Permalink to this definition">¶</a></dt>
|
162
|
+
<dd><p>Retrieve the current specs of a server.</p>
|
163
|
+
<table class="docutils field-list" frame="void" rules="none">
|
164
|
+
<col class="field-name" />
|
165
|
+
<col class="field-body" />
|
166
|
+
<tbody valign="top">
|
167
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
168
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
169
|
+
</ul>
|
170
|
+
</td>
|
171
|
+
</tr>
|
172
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
173
|
+
</td>
|
174
|
+
</tr>
|
175
|
+
</tbody>
|
176
|
+
</table>
|
177
|
+
</dd></dl>
|
178
|
+
|
179
|
+
<dl class="method">
|
180
|
+
<dt id="modify">
|
181
|
+
<code class="descname">modify</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>name: nil</em>, <em>description: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify" title="Permalink to this definition">¶</a></dt>
|
182
|
+
<dd><p>Modify a server.</p>
|
183
|
+
<table class="docutils field-list" frame="void" rules="none">
|
184
|
+
<col class="field-name" />
|
185
|
+
<col class="field-body" />
|
186
|
+
<tbody valign="top">
|
187
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
188
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
189
|
+
<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – server name.</li>
|
190
|
+
<li><strong>description</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – server description.</li>
|
191
|
+
</ul>
|
192
|
+
</td>
|
193
|
+
</tr>
|
194
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
195
|
+
</td>
|
196
|
+
</tr>
|
197
|
+
</tbody>
|
198
|
+
</table>
|
199
|
+
</dd></dl>
|
200
|
+
|
201
|
+
<dl class="method">
|
202
|
+
<dt id="delete">
|
203
|
+
<code class="descname">delete</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>keep_ips: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#delete" title="Permalink to this definition">¶</a></dt>
|
204
|
+
<dd><p>Delete a server.</p>
|
205
|
+
<table class="docutils field-list" frame="void" rules="none">
|
206
|
+
<col class="field-name" />
|
207
|
+
<col class="field-body" />
|
208
|
+
<tbody valign="top">
|
209
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
210
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
211
|
+
<li><strong>keep_ips</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) – Set <code class="docutils literal"><span class="pre">keep_ips</span></code> to <code class="docutils literal"><span class="pre">True</span></code> to keep server IPs after deleting a server. (<code class="docutils literal"><span class="pre">False</span></code> by default).</li>
|
212
|
+
</ul>
|
213
|
+
</td>
|
214
|
+
</tr>
|
215
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
216
|
+
</td>
|
217
|
+
</tr>
|
218
|
+
</tbody>
|
219
|
+
</table>
|
220
|
+
</dd></dl>
|
221
|
+
|
222
|
+
<dl class="method">
|
223
|
+
<dt id="hardware">
|
224
|
+
<code class="descname">hardware</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#hardware" title="Permalink to this definition">¶</a></dt>
|
225
|
+
<dd><p>Retrieve a server’s hardware configurations.</p>
|
226
|
+
<table class="docutils field-list" frame="void" rules="none">
|
227
|
+
<col class="field-name" />
|
228
|
+
<col class="field-body" />
|
229
|
+
<tbody valign="top">
|
230
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
231
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
232
|
+
</ul>
|
233
|
+
</td>
|
234
|
+
</tr>
|
235
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
236
|
+
</td>
|
237
|
+
</tr>
|
238
|
+
</tbody>
|
239
|
+
</table>
|
240
|
+
</dd></dl>
|
241
|
+
|
242
|
+
<dl class="method">
|
243
|
+
<dt id="modify_hardware">
|
244
|
+
<code class="descname">modify_hardware</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>fixed_instance_id: nil</em>, <em>vcore: nil</em>, <em>cores_per_processor: nil</em>, <em>ram: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify_hardware" title="Permalink to this definition">¶</a></dt>
|
245
|
+
<dd><p>Modify a server’s hardware.</p>
|
246
|
+
<div class="admonition note">
|
247
|
+
<p class="first admonition-title">Note</p>
|
248
|
+
<p class="last">Cannot perform “hot” decreasing of server hardware values. “Cold” decreasing is allowed.</p>
|
249
|
+
</div>
|
250
|
+
<table class="docutils field-list" frame="void" rules="none">
|
251
|
+
<col class="field-name" />
|
252
|
+
<col class="field-body" />
|
253
|
+
<tbody valign="top">
|
254
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
255
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
256
|
+
<li><strong>fixed_instance_id</strong> – ID of the instance size for the server. It
|
257
|
+
is not possible to resize to a fixed instance with a HDD smaller than the current one.</li>
|
258
|
+
<li><strong>vcore</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Total amount of virtual cores.</li>
|
259
|
+
<li><strong>cores_per_processor</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Number of cores per processor.</li>
|
260
|
+
<li><strong>ram</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – Memory size.</li>
|
261
|
+
</ul>
|
262
|
+
</td>
|
263
|
+
</tr>
|
264
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
265
|
+
</td>
|
266
|
+
</tr>
|
267
|
+
</tbody>
|
268
|
+
</table>
|
269
|
+
</dd></dl>
|
270
|
+
|
271
|
+
<dl class="method">
|
272
|
+
<dt id="hdds">
|
273
|
+
<code class="descname">hdds</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#hdds" title="Permalink to this definition">¶</a></dt>
|
274
|
+
<dd><p>Returns a list of the server’s HDD’s.</p>
|
275
|
+
<table class="docutils field-list" frame="void" rules="none">
|
276
|
+
<col class="field-name" />
|
277
|
+
<col class="field-body" />
|
278
|
+
<tbody valign="top">
|
279
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
280
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
281
|
+
</ul>
|
282
|
+
</td>
|
283
|
+
</tr>
|
284
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
285
|
+
</td>
|
286
|
+
</tr>
|
287
|
+
</tbody>
|
288
|
+
</table>
|
289
|
+
</dd></dl>
|
290
|
+
|
291
|
+
<dl class="method">
|
292
|
+
<dt id="add_hdds">
|
293
|
+
<code class="descname">add_hdds</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>hdds: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_hdds" title="Permalink to this definition">¶</a></dt>
|
294
|
+
<dd><p>Add additional HDD’s to a server.</p>
|
295
|
+
<table class="docutils field-list" frame="void" rules="none">
|
296
|
+
<col class="field-name" />
|
297
|
+
<col class="field-body" />
|
298
|
+
<tbody valign="top">
|
299
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
300
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
301
|
+
<li><strong>hdds</strong> (<code class="docutils literal"><span class="pre">array</span></code>) – takes an array of HDD’s.</li>
|
302
|
+
</ul>
|
303
|
+
</td>
|
304
|
+
</tr>
|
305
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
306
|
+
</td>
|
307
|
+
</tr>
|
308
|
+
</tbody>
|
309
|
+
</table>
|
310
|
+
</dd></dl>
|
311
|
+
|
312
|
+
<dl class="method">
|
313
|
+
<dt id="get_hdd">
|
314
|
+
<code class="descname">get_hdd</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>hdd_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#get_hdd" title="Permalink to this definition">¶</a></dt>
|
315
|
+
<dd><p>Retrieve information about a server’s HDD.</p>
|
316
|
+
<table class="docutils field-list" frame="void" rules="none">
|
317
|
+
<col class="field-name" />
|
318
|
+
<col class="field-body" />
|
319
|
+
<tbody valign="top">
|
320
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
321
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
322
|
+
<li><strong>hdd_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the HDD.</li>
|
323
|
+
</ul>
|
324
|
+
</td>
|
325
|
+
</tr>
|
326
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
327
|
+
</td>
|
328
|
+
</tr>
|
329
|
+
</tbody>
|
330
|
+
</table>
|
331
|
+
</dd></dl>
|
332
|
+
|
333
|
+
<dl class="method">
|
334
|
+
<dt id="modify_hdd">
|
335
|
+
<code class="descname">modify_hdd</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>hdd_id: nil</em>, <em>size: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#modify_hdd" title="Permalink to this definition">¶</a></dt>
|
336
|
+
<dd><p>Modify a server’s HDD.</p>
|
337
|
+
<table class="docutils field-list" frame="void" rules="none">
|
338
|
+
<col class="field-name" />
|
339
|
+
<col class="field-body" />
|
340
|
+
<tbody valign="top">
|
341
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
342
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
343
|
+
<li><strong>hdd_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s HDD.</li>
|
344
|
+
<li><strong>size</strong> (<code class="docutils literal"><span class="pre">int</span></code>) – the new size of the HDD. Must be a multiple of <code class="docutils literal"><span class="pre">20</span></code>.</li>
|
345
|
+
</ul>
|
346
|
+
</td>
|
347
|
+
</tr>
|
348
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
349
|
+
</td>
|
350
|
+
</tr>
|
351
|
+
</tbody>
|
352
|
+
</table>
|
353
|
+
</dd></dl>
|
354
|
+
|
355
|
+
<dl class="method">
|
356
|
+
<dt id="delete_hdd">
|
357
|
+
<code class="descname">delete_hdd</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>hdd_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#delete_hdd" title="Permalink to this definition">¶</a></dt>
|
358
|
+
<dd><p>Delete a server’s HDD.</p>
|
359
|
+
<table class="docutils field-list" frame="void" rules="none">
|
360
|
+
<col class="field-name" />
|
361
|
+
<col class="field-body" />
|
362
|
+
<tbody valign="top">
|
363
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
364
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
365
|
+
<li><strong>hdd_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s HDD.</li>
|
366
|
+
</ul>
|
367
|
+
</td>
|
368
|
+
</tr>
|
369
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
370
|
+
</td>
|
371
|
+
</tr>
|
372
|
+
</tbody>
|
373
|
+
</table>
|
374
|
+
</dd></dl>
|
375
|
+
|
376
|
+
<dl class="method">
|
377
|
+
<dt id="image">
|
378
|
+
<code class="descname">image</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#image" title="Permalink to this definition">¶</a></dt>
|
379
|
+
<dd><p>Returns information about a server’s image.</p>
|
380
|
+
<table class="docutils field-list" frame="void" rules="none">
|
381
|
+
<col class="field-name" />
|
382
|
+
<col class="field-body" />
|
383
|
+
<tbody valign="top">
|
384
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
385
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
386
|
+
</ul>
|
387
|
+
</td>
|
388
|
+
</tr>
|
389
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
390
|
+
</td>
|
391
|
+
</tr>
|
392
|
+
</tbody>
|
393
|
+
</table>
|
394
|
+
</dd></dl>
|
395
|
+
|
396
|
+
<dl class="method">
|
397
|
+
<dt id="install_image">
|
398
|
+
<code class="descname">install_image</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>image_id: nil</em>, <em>password: nil</em>, <em>firewall_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#install_image" title="Permalink to this definition">¶</a></dt>
|
399
|
+
<dd><p>Installs an image onto the server.</p>
|
400
|
+
<table class="docutils field-list" frame="void" rules="none">
|
401
|
+
<col class="field-name" />
|
402
|
+
<col class="field-body" />
|
403
|
+
<tbody valign="top">
|
404
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
405
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
406
|
+
<li><strong>image_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server image.</li>
|
407
|
+
<li><strong>password</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – server password.</li>
|
408
|
+
<li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the firewall policy to be assigned.</li>
|
409
|
+
</ul>
|
410
|
+
</td>
|
411
|
+
</tr>
|
412
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
413
|
+
</td>
|
414
|
+
</tr>
|
415
|
+
</tbody>
|
416
|
+
</table>
|
417
|
+
</dd></dl>
|
418
|
+
|
419
|
+
<dl class="method">
|
420
|
+
<dt id="ips">
|
421
|
+
<code class="descname">ips</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#ips" title="Permalink to this definition">¶</a></dt>
|
422
|
+
<dd><p>Returns a list of the server’s IP’s.</p>
|
423
|
+
<table class="docutils field-list" frame="void" rules="none">
|
424
|
+
<col class="field-name" />
|
425
|
+
<col class="field-body" />
|
426
|
+
<tbody valign="top">
|
427
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
428
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
429
|
+
</ul>
|
430
|
+
</td>
|
431
|
+
</tr>
|
432
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
433
|
+
</td>
|
434
|
+
</tr>
|
435
|
+
</tbody>
|
436
|
+
</table>
|
437
|
+
</dd></dl>
|
438
|
+
|
439
|
+
<dl class="method">
|
440
|
+
<dt id="add_ip">
|
441
|
+
<code class="descname">add_ip</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_type: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_ip" title="Permalink to this definition">¶</a></dt>
|
442
|
+
<dd><p>Add an IP to the server.</p>
|
443
|
+
<table class="docutils field-list" frame="void" rules="none">
|
444
|
+
<col class="field-name" />
|
445
|
+
<col class="field-body" />
|
446
|
+
<tbody valign="top">
|
447
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
448
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
449
|
+
<li><strong>ip_type</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – at the moment, only <code class="docutils literal"><span class="pre">`IPV4`</span></code> is currently supported.</li>
|
450
|
+
</ul>
|
451
|
+
</td>
|
452
|
+
</tr>
|
453
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
454
|
+
</td>
|
455
|
+
</tr>
|
456
|
+
</tbody>
|
457
|
+
</table>
|
458
|
+
</dd></dl>
|
459
|
+
|
460
|
+
<dl class="method">
|
461
|
+
<dt id="ip">
|
462
|
+
<code class="descname">ip</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#ip" title="Permalink to this definition">¶</a></dt>
|
463
|
+
<dd><p>Returns information about a server’s IP.</p>
|
464
|
+
<table class="docutils field-list" frame="void" rules="none">
|
465
|
+
<col class="field-name" />
|
466
|
+
<col class="field-body" />
|
467
|
+
<tbody valign="top">
|
468
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
469
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
470
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the IP.</li>
|
471
|
+
</ul>
|
472
|
+
</td>
|
473
|
+
</tr>
|
474
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
475
|
+
</td>
|
476
|
+
</tr>
|
477
|
+
</tbody>
|
478
|
+
</table>
|
479
|
+
</dd></dl>
|
480
|
+
|
481
|
+
<dl class="method">
|
482
|
+
<dt id="release_ip">
|
483
|
+
<code class="descname">release_ip</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em>, <em>keep_ip: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#release_ip" title="Permalink to this definition">¶</a></dt>
|
484
|
+
<dd><p>Release an IP from the server.</p>
|
485
|
+
<table class="docutils field-list" frame="void" rules="none">
|
486
|
+
<col class="field-name" />
|
487
|
+
<col class="field-body" />
|
488
|
+
<tbody valign="top">
|
489
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
490
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
491
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
492
|
+
<li><strong>keep_ip</strong> (<code class="docutils literal"><span class="pre">bool</span></code>) – Set <code class="docutils literal"><span class="pre">keep_ip</span></code> to <code class="docutils literal"><span class="pre">True</span></code> for releasing the IP without deleting it permanently. (<code class="docutils literal"><span class="pre">False</span></code> by default)</li>
|
493
|
+
</ul>
|
494
|
+
</td>
|
495
|
+
</tr>
|
496
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
497
|
+
</td>
|
498
|
+
</tr>
|
499
|
+
</tbody>
|
500
|
+
</table>
|
501
|
+
</dd></dl>
|
502
|
+
|
503
|
+
<dl class="method">
|
504
|
+
<dt id="add_firewall">
|
505
|
+
<code class="descname">add_firewall</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em>, <em>firewall_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_firewall" title="Permalink to this definition">¶</a></dt>
|
506
|
+
<dd><p>Add a firewall policy to a server’s IP.</p>
|
507
|
+
<table class="docutils field-list" frame="void" rules="none">
|
508
|
+
<col class="field-name" />
|
509
|
+
<col class="field-body" />
|
510
|
+
<tbody valign="top">
|
511
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
512
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
513
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
514
|
+
<li><strong>firewall_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the firewall policy.</li>
|
515
|
+
</ul>
|
516
|
+
</td>
|
517
|
+
</tr>
|
518
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
519
|
+
</td>
|
520
|
+
</tr>
|
521
|
+
</tbody>
|
522
|
+
</table>
|
523
|
+
</dd></dl>
|
524
|
+
|
525
|
+
<dl class="method">
|
526
|
+
<dt id="firewall">
|
527
|
+
<code class="descname">firewall</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#firewall" title="Permalink to this definition">¶</a></dt>
|
528
|
+
<dd><p>Returns information about a server IP’s firewall policy.</p>
|
529
|
+
<table class="docutils field-list" frame="void" rules="none">
|
530
|
+
<col class="field-name" />
|
531
|
+
<col class="field-body" />
|
532
|
+
<tbody valign="top">
|
533
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
534
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
535
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
536
|
+
</ul>
|
537
|
+
</td>
|
538
|
+
</tr>
|
539
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
540
|
+
</td>
|
541
|
+
</tr>
|
542
|
+
</tbody>
|
543
|
+
</table>
|
544
|
+
</dd></dl>
|
545
|
+
|
546
|
+
<dl class="method">
|
547
|
+
<dt id="remove_firewall">
|
548
|
+
<code class="descname">remove_firewall</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_firewall" title="Permalink to this definition">¶</a></dt>
|
549
|
+
<dd><p>Remove a firewall policy from a server’s IP.</p>
|
550
|
+
<table class="docutils field-list" frame="void" rules="none">
|
551
|
+
<col class="field-name" />
|
552
|
+
<col class="field-body" />
|
553
|
+
<tbody valign="top">
|
554
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
555
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
556
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
557
|
+
</ul>
|
558
|
+
</td>
|
559
|
+
</tr>
|
560
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
561
|
+
</td>
|
562
|
+
</tr>
|
563
|
+
</tbody>
|
564
|
+
</table>
|
565
|
+
</dd></dl>
|
566
|
+
|
567
|
+
<dl class="method">
|
568
|
+
<dt id="load_balancers">
|
569
|
+
<code class="descname">load_balancers</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#load_balancers" title="Permalink to this definition">¶</a></dt>
|
570
|
+
<dd><p>Returns a list of the load balancers assigned to a server IP.</p>
|
571
|
+
<table class="docutils field-list" frame="void" rules="none">
|
572
|
+
<col class="field-name" />
|
573
|
+
<col class="field-body" />
|
574
|
+
<tbody valign="top">
|
575
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
576
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
577
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
578
|
+
</ul>
|
579
|
+
</td>
|
580
|
+
</tr>
|
581
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
582
|
+
</td>
|
583
|
+
</tr>
|
584
|
+
</tbody>
|
585
|
+
</table>
|
586
|
+
</dd></dl>
|
587
|
+
|
588
|
+
<dl class="method">
|
589
|
+
<dt id="add_load_balancer">
|
590
|
+
<code class="descname">add_load_balancer</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em>, <em>load_balancer_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_load_balancer" title="Permalink to this definition">¶</a></dt>
|
591
|
+
<dd><p>Add a load balancer to a server’s IP.</p>
|
592
|
+
<table class="docutils field-list" frame="void" rules="none">
|
593
|
+
<col class="field-name" />
|
594
|
+
<col class="field-body" />
|
595
|
+
<tbody valign="top">
|
596
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
597
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
598
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
599
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
600
|
+
</ul>
|
601
|
+
</td>
|
602
|
+
</tr>
|
603
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
604
|
+
</td>
|
605
|
+
</tr>
|
606
|
+
</tbody>
|
607
|
+
</table>
|
608
|
+
</dd></dl>
|
609
|
+
|
610
|
+
<dl class="method">
|
611
|
+
<dt id="remove_load_balancer">
|
612
|
+
<code class="descname">remove_load_balancer</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>ip_id: nil</em>, <em>load_balancer_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_load_balancer" title="Permalink to this definition">¶</a></dt>
|
613
|
+
<dd><p>Remove a load balancer from a server’s IP.</p>
|
614
|
+
<table class="docutils field-list" frame="void" rules="none">
|
615
|
+
<col class="field-name" />
|
616
|
+
<col class="field-body" />
|
617
|
+
<tbody valign="top">
|
618
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
619
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
620
|
+
<li><strong>ip_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server’s IP.</li>
|
621
|
+
<li><strong>load_balancer_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the load balancer.</li>
|
622
|
+
</ul>
|
623
|
+
</td>
|
624
|
+
</tr>
|
625
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
626
|
+
</td>
|
627
|
+
</tr>
|
628
|
+
</tbody>
|
629
|
+
</table>
|
630
|
+
</dd></dl>
|
631
|
+
|
632
|
+
<dl class="method">
|
633
|
+
<dt id="status">
|
634
|
+
<code class="descname">status</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#status" title="Permalink to this definition">¶</a></dt>
|
635
|
+
<dd><p>Retrieve the server’s current state.</p>
|
636
|
+
<table class="docutils field-list" frame="void" rules="none">
|
637
|
+
<col class="field-name" />
|
638
|
+
<col class="field-body" />
|
639
|
+
<tbody valign="top">
|
640
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
641
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
642
|
+
</ul>
|
643
|
+
</td>
|
644
|
+
</tr>
|
645
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
646
|
+
</td>
|
647
|
+
</tr>
|
648
|
+
</tbody>
|
649
|
+
</table>
|
650
|
+
</dd></dl>
|
651
|
+
|
652
|
+
<dl class="method">
|
653
|
+
<dt id="change_status">
|
654
|
+
<code class="descname">change_status</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>action: nil</em>, <em>method: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#change_status" title="Permalink to this definition">¶</a></dt>
|
655
|
+
<dd><p>Modify a server’s state.</p>
|
656
|
+
<table class="docutils field-list" frame="void" rules="none">
|
657
|
+
<col class="field-name" />
|
658
|
+
<col class="field-body" />
|
659
|
+
<tbody valign="top">
|
660
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
661
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
662
|
+
<li><strong>action</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the action to perform on the server. Possible values are <code class="docutils literal"><span class="pre">'POWER_OFF'</span></code>, <code class="docutils literal"><span class="pre">'POWER_ON'</span></code>, and <code class="docutils literal"><span class="pre">'REBOOT'</span></code>.</li>
|
663
|
+
<li><strong>method</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the action’s method. Possible values are <code class="docutils literal"><span class="pre">'SOFTWARE'</span></code> or <code class="docutils literal"><span class="pre">'HARDWARE'</span></code>.</li>
|
664
|
+
</ul>
|
665
|
+
</td>
|
666
|
+
</tr>
|
667
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
668
|
+
</td>
|
669
|
+
</tr>
|
670
|
+
</tbody>
|
671
|
+
</table>
|
672
|
+
</dd></dl>
|
673
|
+
|
674
|
+
<dl class="method">
|
675
|
+
<dt id="dvd">
|
676
|
+
<code class="descname">dvd</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#dvd" title="Permalink to this definition">¶</a></dt>
|
677
|
+
<dd><p>Returns information about the DVD currently loaded into the server.</p>
|
678
|
+
<table class="docutils field-list" frame="void" rules="none">
|
679
|
+
<col class="field-name" />
|
680
|
+
<col class="field-body" />
|
681
|
+
<tbody valign="top">
|
682
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
683
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
684
|
+
</ul>
|
685
|
+
</td>
|
686
|
+
</tr>
|
687
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
688
|
+
</td>
|
689
|
+
</tr>
|
690
|
+
</tbody>
|
691
|
+
</table>
|
692
|
+
</dd></dl>
|
693
|
+
|
694
|
+
<dl class="method">
|
695
|
+
<dt id="load_dvd">
|
696
|
+
<code class="descname">load_dvd</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>dvd_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#load_dvd" title="Permalink to this definition">¶</a></dt>
|
697
|
+
<dd><p>Loads a DVD into the server.</p>
|
698
|
+
<table class="docutils field-list" frame="void" rules="none">
|
699
|
+
<col class="field-name" />
|
700
|
+
<col class="field-body" />
|
701
|
+
<tbody valign="top">
|
702
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
703
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
704
|
+
<li><strong>dvd_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the DVD.</li>
|
705
|
+
</ul>
|
706
|
+
</td>
|
707
|
+
</tr>
|
708
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
709
|
+
</td>
|
710
|
+
</tr>
|
711
|
+
</tbody>
|
712
|
+
</table>
|
713
|
+
</dd></dl>
|
714
|
+
|
715
|
+
<dl class="method">
|
716
|
+
<dt id="eject_dvd">
|
717
|
+
<code class="descname">eject_dvd</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#eject_dvd" title="Permalink to this definition">¶</a></dt>
|
718
|
+
<dd><p>Eject the DVD from the server.</p>
|
719
|
+
<table class="docutils field-list" frame="void" rules="none">
|
720
|
+
<col class="field-name" />
|
721
|
+
<col class="field-body" />
|
722
|
+
<tbody valign="top">
|
723
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
724
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
725
|
+
</ul>
|
726
|
+
</td>
|
727
|
+
</tr>
|
728
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
729
|
+
</td>
|
730
|
+
</tr>
|
731
|
+
</tbody>
|
732
|
+
</table>
|
733
|
+
</dd></dl>
|
734
|
+
|
735
|
+
<dl class="method">
|
736
|
+
<dt id="private_networks">
|
737
|
+
<code class="descname">private_networks</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#private_networks" title="Permalink to this definition">¶</a></dt>
|
738
|
+
<dd><p>Returns a list of the server’s private networks.</p>
|
739
|
+
<table class="docutils field-list" frame="void" rules="none">
|
740
|
+
<col class="field-name" />
|
741
|
+
<col class="field-body" />
|
742
|
+
<tbody valign="top">
|
743
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
744
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
745
|
+
</ul>
|
746
|
+
</td>
|
747
|
+
</tr>
|
748
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
749
|
+
</td>
|
750
|
+
</tr>
|
751
|
+
</tbody>
|
752
|
+
</table>
|
753
|
+
</dd></dl>
|
754
|
+
|
755
|
+
<dl class="method">
|
756
|
+
<dt id="private_network">
|
757
|
+
<code class="descname">private_network</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>private_network_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#private_network" title="Permalink to this definition">¶</a></dt>
|
758
|
+
<dd><p>Returns information about a server’s private network.</p>
|
759
|
+
<table class="docutils field-list" frame="void" rules="none">
|
760
|
+
<col class="field-name" />
|
761
|
+
<col class="field-body" />
|
762
|
+
<tbody valign="top">
|
763
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
764
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
765
|
+
<li><strong>private_network_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the private network.</li>
|
766
|
+
</ul>
|
767
|
+
</td>
|
768
|
+
</tr>
|
769
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
770
|
+
</td>
|
771
|
+
</tr>
|
772
|
+
</tbody>
|
773
|
+
</table>
|
774
|
+
</dd></dl>
|
775
|
+
|
776
|
+
<dl class="method">
|
777
|
+
<dt id="remove_private_network">
|
778
|
+
<code class="descname">remove_private_network</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>private_network_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#remove_private_network" title="Permalink to this definition">¶</a></dt>
|
779
|
+
<dd><p>Removes a server from a private network.</p>
|
780
|
+
<table class="docutils field-list" frame="void" rules="none">
|
781
|
+
<col class="field-name" />
|
782
|
+
<col class="field-body" />
|
783
|
+
<tbody valign="top">
|
784
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
785
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
786
|
+
<li><strong>private_network_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the private network.</li>
|
787
|
+
</ul>
|
788
|
+
</td>
|
789
|
+
</tr>
|
790
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
791
|
+
</td>
|
792
|
+
</tr>
|
793
|
+
</tbody>
|
794
|
+
</table>
|
795
|
+
</dd></dl>
|
796
|
+
|
797
|
+
<dl class="method">
|
798
|
+
<dt id="add_private_network">
|
799
|
+
<code class="descname">add_private_network</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>private_network_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#add_private_network" title="Permalink to this definition">¶</a></dt>
|
800
|
+
<dd><p>Add a server to a private network.</p>
|
801
|
+
<table class="docutils field-list" frame="void" rules="none">
|
802
|
+
<col class="field-name" />
|
803
|
+
<col class="field-body" />
|
804
|
+
<tbody valign="top">
|
805
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
806
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
807
|
+
<li><strong>private_network_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the private network.</li>
|
808
|
+
</ul>
|
809
|
+
</td>
|
810
|
+
</tr>
|
811
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
812
|
+
</td>
|
813
|
+
</tr>
|
814
|
+
</tbody>
|
815
|
+
</table>
|
816
|
+
</dd></dl>
|
817
|
+
|
818
|
+
<dl class="method">
|
819
|
+
<dt id="create_snapshot">
|
820
|
+
<code class="descname">create_snapshot</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#create_snapshot" title="Permalink to this definition">¶</a></dt>
|
821
|
+
<dd><p>Creates a server snapshot.</p>
|
822
|
+
<table class="docutils field-list" frame="void" rules="none">
|
823
|
+
<col class="field-name" />
|
824
|
+
<col class="field-body" />
|
825
|
+
<tbody valign="top">
|
826
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
827
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
828
|
+
</ul>
|
829
|
+
</td>
|
830
|
+
</tr>
|
831
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
832
|
+
</td>
|
833
|
+
</tr>
|
834
|
+
</tbody>
|
835
|
+
</table>
|
836
|
+
</dd></dl>
|
837
|
+
|
838
|
+
<dl class="method">
|
839
|
+
<dt id="snapshot">
|
840
|
+
<code class="descname">snapshot</code><span class="sig-paren">(</span><em>server_id: @id</em><span class="sig-paren">)</span><a class="headerlink" href="#snapshot" title="Permalink to this definition">¶</a></dt>
|
841
|
+
<dd><p>Returns information about a server’s snapshot.</p>
|
842
|
+
<table class="docutils field-list" frame="void" rules="none">
|
843
|
+
<col class="field-name" />
|
844
|
+
<col class="field-body" />
|
845
|
+
<tbody valign="top">
|
846
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
847
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
848
|
+
</ul>
|
849
|
+
</td>
|
850
|
+
</tr>
|
851
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
852
|
+
</td>
|
853
|
+
</tr>
|
854
|
+
</tbody>
|
855
|
+
</table>
|
856
|
+
</dd></dl>
|
857
|
+
|
858
|
+
<dl class="method">
|
859
|
+
<dt id="restore_snapshot">
|
860
|
+
<code class="descname">restore_snapshot</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>snapshot_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#restore_snapshot" title="Permalink to this definition">¶</a></dt>
|
861
|
+
<dd><p>Restore a server’s snapshot.</p>
|
862
|
+
<table class="docutils field-list" frame="void" rules="none">
|
863
|
+
<col class="field-name" />
|
864
|
+
<col class="field-body" />
|
865
|
+
<tbody valign="top">
|
866
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
867
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
868
|
+
<li><strong>snapshot_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server snapshot.</li>
|
869
|
+
</ul>
|
870
|
+
</td>
|
871
|
+
</tr>
|
872
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
873
|
+
</td>
|
874
|
+
</tr>
|
875
|
+
</tbody>
|
876
|
+
</table>
|
877
|
+
</dd></dl>
|
878
|
+
|
879
|
+
<dl class="method">
|
880
|
+
<dt id="delete_snapshot">
|
881
|
+
<code class="descname">delete_snapshot</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>snapshot_id: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#delete_snapshot" title="Permalink to this definition">¶</a></dt>
|
882
|
+
<dd><p>Remove a server’s snapshot.</p>
|
883
|
+
<table class="docutils field-list" frame="void" rules="none">
|
884
|
+
<col class="field-name" />
|
885
|
+
<col class="field-body" />
|
886
|
+
<tbody valign="top">
|
887
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
888
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server.</li>
|
889
|
+
<li><strong>snapshot_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server snapshot.</li>
|
890
|
+
</ul>
|
891
|
+
</td>
|
892
|
+
</tr>
|
893
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
894
|
+
</td>
|
895
|
+
</tr>
|
896
|
+
</tbody>
|
897
|
+
</table>
|
898
|
+
</dd></dl>
|
899
|
+
|
900
|
+
<dl class="method">
|
901
|
+
<dt id="clone">
|
902
|
+
<code class="descname">clone</code><span class="sig-paren">(</span><em>server_id: @id</em>, <em>name: nil</em><span class="sig-paren">)</span><a class="headerlink" href="#clone" title="Permalink to this definition">¶</a></dt>
|
903
|
+
<dd><p>Clone a server.</p>
|
904
|
+
<table class="docutils field-list" frame="void" rules="none">
|
905
|
+
<col class="field-name" />
|
906
|
+
<col class="field-body" />
|
907
|
+
<tbody valign="top">
|
908
|
+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
909
|
+
<li><strong>server_id</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the unique identifier for the server to be cloned.</li>
|
910
|
+
<li><strong>name</strong> (<code class="docutils literal"><span class="pre">str</span></code>) – the new server’s name.</li>
|
911
|
+
</ul>
|
912
|
+
</td>
|
913
|
+
</tr>
|
914
|
+
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">JSON</p>
|
915
|
+
</td>
|
916
|
+
</tr>
|
917
|
+
</tbody>
|
918
|
+
</table>
|
919
|
+
</dd></dl>
|
920
|
+
|
921
|
+
<dl class="method">
|
922
|
+
<dt id="wait_for">
|
923
|
+
<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>
|
924
|
+
<dd><p>Polls the server until an “ACTIVE”, “POWERED_ON”, or “POWERED_OFF” state is returned. Use this when chaining actions.</p>
|
925
|
+
<table class="docutils field-list" frame="void" rules="none">
|
926
|
+
<col class="field-name" />
|
927
|
+
<col class="field-body" />
|
928
|
+
<tbody valign="top">
|
929
|
+
<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>
|
930
|
+
</tr>
|
931
|
+
</tbody>
|
932
|
+
</table>
|
933
|
+
</dd></dl>
|
934
|
+
|
935
|
+
</div></blockquote>
|
936
|
+
</dd></dl>
|
937
|
+
|
938
|
+
</div>
|
939
|
+
|
940
|
+
|
941
|
+
</div>
|
942
|
+
</div>
|
943
|
+
</div>
|
944
|
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
945
|
+
<div class="sphinxsidebarwrapper"><div class="relations">
|
946
|
+
<h3>Related Topics</h3>
|
947
|
+
<ul>
|
948
|
+
<li><a href="index.html">Documentation overview</a><ul>
|
949
|
+
<li>Previous: <a href="index.html" title="previous chapter">1&1’s Ruby SDK</a></li>
|
950
|
+
<li>Next: <a href="images.html" title="next chapter">Images</a></li>
|
951
|
+
</ul></li>
|
952
|
+
</ul>
|
953
|
+
</div>
|
954
|
+
<div role="note" aria-label="source link">
|
955
|
+
<h3>This Page</h3>
|
956
|
+
<ul class="this-page-menu">
|
957
|
+
<li><a href="_sources/servers.txt"
|
958
|
+
rel="nofollow">Show Source</a></li>
|
959
|
+
</ul>
|
960
|
+
</div>
|
961
|
+
<div id="searchbox" style="display: none" role="search">
|
962
|
+
<h3>Quick search</h3>
|
963
|
+
<form class="search" action="search.html" method="get">
|
964
|
+
<input type="text" name="q" />
|
965
|
+
<input type="submit" value="Go" />
|
966
|
+
<input type="hidden" name="check_keywords" value="yes" />
|
967
|
+
<input type="hidden" name="area" value="default" />
|
968
|
+
</form>
|
969
|
+
<p class="searchtip" style="font-size: 90%">
|
970
|
+
Enter search terms or a module, class or function name.
|
971
|
+
</p>
|
972
|
+
</div>
|
973
|
+
<script type="text/javascript">$('#searchbox').show(0);</script>
|
974
|
+
</div>
|
975
|
+
</div>
|
976
|
+
<div class="clearer"></div>
|
977
|
+
</div>
|
978
|
+
<div class="footer">
|
979
|
+
©2016, StackPointCloud, Inc..
|
980
|
+
|
981
|
+
|
|
982
|
+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.3</a>
|
983
|
+
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
984
|
+
|
985
|
+
|
|
986
|
+
<a href="_sources/servers.txt"
|
987
|
+
rel="nofollow">Page source</a>
|
988
|
+
</div>
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
|
993
|
+
</body>
|
994
|
+
</html>
|