← Back to branch summary

~ubuntu-branches/ubuntu/saucy/python-cinderclient/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/source/ref/servers.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-06-27 13:32:14 UTC
  • Revision ID: package-import@ubuntu.com-20120627133214-n2gx1yxu97efvhg8
Tags: upstream-2012.2~f1~20120621.8
Import upstream version 2012.2~f1~20120621.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/ref/servers.rst
 
1
Servers
 
2
=======
 
3
 
 
4
A virtual machine instance.
 
5
 
 
6
Classes
 
7
-------
 
8
 
 
9
.. currentmodule:: cinderclient
 
10
 
 
11
.. autoclass:: ServerManager
 
12
   :members: get, list, find, findall, create, update, delete, share_ip,
 
13
             unshare_ip, reboot, rebuild, resize, confirm_resize,
 
14
             revert_resize
 
15
 
 
16
.. autoclass:: Server
 
17
   :members: update, delete, share_ip, unshare_ip, reboot, rebuild, resize,
 
18
             confirm_resize, revert_resize
 
19
 
 
20
   .. attribute:: id
 
21
 
 
22
        This server's ID.
 
23
 
 
24
   .. attribute:: name
 
25
 
 
26
        The name you gave the server when you booted it.
 
27
 
 
28
   .. attribute:: imageId
 
29
 
 
30
        The :class:`Image` this server was booted with.
 
31
 
 
32
   .. attribute:: flavorId
 
33
 
 
34
        This server's current :class:`Flavor`.
 
35
 
 
36
   .. attribute:: hostId
 
37
 
 
38
        Rackspace doesn't document this value. It appears to be SHA1 hash.
 
39
 
 
40
   .. attribute:: status
 
41
 
 
42
        The server's status (``BOOTING``, ``ACTIVE``, etc).
 
43
 
 
44
   .. attribute:: progress
 
45
 
 
46
        When booting, resizing, updating, etc., this will be set to a
 
47
        value between 0 and 100 giving a rough estimate of the progress
 
48
        of the current operation.
 
49
 
 
50
   .. attribute:: addresses
 
51
 
 
52
        The public and private IP addresses of this server. This'll be a dict
 
53
        of the form::
 
54
 
 
55
            {
 
56
              "public" : ["67.23.10.138"],
 
57
              "private" : ["10.176.42.19"]
 
58
            }
 
59
 
 
60
        You *can* get more than one public/private IP provisioned, but not
 
61
        directly from the API; you'll need to open a support ticket.
 
62
 
 
63
   .. attribute:: metadata
 
64
 
 
65
        The metadata dict you gave when creating the server.
 
66
 
 
67
Constants
 
68
---------
 
69
 
 
70
Reboot types:
 
71
 
 
72
.. data:: REBOOT_SOFT
 
73
.. data:: REBOOT_HARD