File: ipgroups.html

package info (click to toggle)
python-cloudservers 1.1-1.2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 2,724 kB
  • sloc: python: 2,004; makefile: 79
file content (266 lines) | stat: -rw-r--r-- 12,818 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Shared IP addresses &mdash; python-cloudservers v1.0 documentation</title>
    <link rel="stylesheet" href="../_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="python-cloudservers v1.0 documentation" href="../index.html" />
    <link rel="up" title="API Reference" href="index.html" />
    <link rel="next" title="Servers" href="servers.html" />
    <link rel="prev" title="Images" href="images.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="servers.html" title="Servers"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="images.html" title="Images"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">python-cloudservers v1.0 documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">API Reference</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="shared-ip-addresses">
<h1>Shared IP addresses<a class="headerlink" href="#shared-ip-addresses" title="Permalink to this headline">¶</a></h1>
<p>From the Rackspace API guide:</p>
<blockquote>
<p>Public IP addresses can be shared across multiple servers for use in
various high availability scenarios. When an IP address is shared to
another server, the cloud network restrictions are modified to allow each
server to listen to and respond on that IP address (you may optionally
specify that the target server network configuration be modified). Shared
IP addresses can be used with many standard heartbeat facilities (e.g.
<tt class="docutils literal"><span class="pre">keepalived</span></tt>) that monitor for failure and manage IP failover.</p>
<p>A shared IP group is a collection of servers that can share IPs with other
members of the group. Any server in a group can share one or more public
IPs with any other server in the group. With the exception of the first
server in a shared IP group, servers must be launched into shared IP
groups. A server may only be a member of one shared IP group.</p>
</blockquote>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">Use <tt class="xref py py-meth docutils literal"><span class="pre">Server.share_ip()</span></tt> and <cite>Server.unshare_ip</cite> to share and unshare
IPs in a group.</p>
</div>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="cloudservers.IPGroupManager">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">IPGroupManager</tt><big>(</big><em>api</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="cloudservers.IPGroupManager.get">
<tt class="descname">get</tt><big>(</big><em>group</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get an IP group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>group</strong> &#8211; ID of the image to get.</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">&lt;pending_xref py:class=&#8221;IPGroupManager&#8221; py:module=&#8221;cloudservers&#8221; refdoc=&#8221;ref/ipgroups&#8221; refdomain=&#8221;py&#8221; refexplicit=&#8221;False&#8221; reftarget=&#8221;IPGroup&#8221; reftype=&#8221;class&#8221;&gt;&lt;literal classes=&#8221;xref py py-class&#8221;&gt;IPGroup&lt;/literal&gt;&lt;/pending_xref&gt;</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cloudservers.IPGroupManager.list">
<tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager.list" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of all groups.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">list of <a title="cloudservers.IPGroup" class="reference internal" href="#cloudservers.IPGroup"><tt class="xref py py-class docutils literal"><span class="pre">IPGroup</span></tt></a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cloudservers.IPGroupManager.find">
<tt class="descname">find</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager.find" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a single item with attributes matching <tt class="docutils literal"><span class="pre">**kwargs</span></tt>.</p>
<p>This isn&#8217;t very efficient: it loads the entire list then filters on
the Python side.</p>
</dd></dl>

<dl class="method">
<dt id="cloudservers.IPGroupManager.findall">
<tt class="descname">findall</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager.findall" title="Permalink to this definition">¶</a></dt>
<dd><p>Find all items with attributes matching <tt class="docutils literal"><span class="pre">**kwargs</span></tt>.</p>
<p>This isn&#8217;t very efficient: it loads the entire list then filters on
the Python side.</p>
</dd></dl>

<dl class="method">
<dt id="cloudservers.IPGroupManager.create">
<tt class="descname">create</tt><big>(</big><em>name</em>, <em>server=None</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager.create" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new <a title="cloudservers.IPGroup" class="reference internal" href="#cloudservers.IPGroup"><tt class="xref py py-class docutils literal"><span class="pre">IPGroup</span></tt></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> &#8211; An (arbitrary) name for the new image.</li>
<li><strong>server</strong> &#8211; A <a title="cloudservers.Server" class="reference external" href="servers.html#cloudservers.Server"><tt class="xref py py-class docutils literal"><span class="pre">Server</span></tt></a> (or its ID) to make a member of this group.</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">&lt;pending_xref py:class=&#8221;IPGroupManager&#8221; py:module=&#8221;cloudservers&#8221; refdoc=&#8221;ref/ipgroups&#8221; refdomain=&#8221;py&#8221; refexplicit=&#8221;False&#8221; reftarget=&#8221;IPGroup&#8221; reftype=&#8221;class&#8221;&gt;&lt;literal classes=&#8221;xref py py-class&#8221;&gt;IPGroup&lt;/literal&gt;&lt;/pending_xref&gt;</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="cloudservers.IPGroupManager.delete">
<tt class="descname">delete</tt><big>(</big><em>group</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroupManager.delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a group.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>group</strong> &#8211; The <a title="cloudservers.IPGroup" class="reference internal" href="#cloudservers.IPGroup"><tt class="xref py py-class docutils literal"><span class="pre">IPGroup</span></tt></a> (or its ID) to delete.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="cloudservers.IPGroup">
<em class="property">class </em><tt class="descclassname">cloudservers.</tt><tt class="descname">IPGroup</tt><big>(</big><em>manager</em>, <em>info</em><big>)</big><a class="headerlink" href="#cloudservers.IPGroup" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="cloudservers.IPGroup.id">
<tt class="descname">id</tt><a class="headerlink" href="#cloudservers.IPGroup.id" title="Permalink to this definition">¶</a></dt>
<dd>Shared group ID.</dd></dl>

<dl class="attribute">
<dt id="cloudservers.IPGroup.name">
<tt class="descname">name</tt><a class="headerlink" href="#cloudservers.IPGroup.name" title="Permalink to this definition">¶</a></dt>
<dd>Name of the group.</dd></dl>

<dl class="attribute">
<dt id="cloudservers.IPGroup.servers">
<tt class="descname">servers</tt><a class="headerlink" href="#cloudservers.IPGroup.servers" title="Permalink to this definition">¶</a></dt>
<dd>A list of server IDs in this group.</dd></dl>

<dl class="method">
<dt id="cloudservers.IPGroup.delete">
<tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#cloudservers.IPGroup.delete" title="Permalink to this definition">¶</a></dt>
<dd>Delete this group.</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference external" href="#">Shared IP addresses</a><ul>
<li><a class="reference external" href="#classes">Classes</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="images.html"
                        title="previous chapter">Images</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="servers.html"
                        title="next chapter">Servers</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/ref/ipgroups.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="servers.html" title="Servers"
             >next</a> |</li>
        <li class="right" >
          <a href="images.html" title="Images"
             >previous</a> |</li>
        <li><a href="../index.html">python-cloudservers v1.0 documentation</a> &raquo;</li>
          <li><a href="index.html" >API Reference</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2009, Jacob Kaplan-Moss.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0pre.
    </div>
  </body>
</html>