7547dadf87
To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc and build results go in project/doc/build. Change-Id: I3ae14ac735d9b4c0b534eac9a9c142f8ccaac1b9
74 lines
1.6 KiB
ReStructuredText
74 lines
1.6 KiB
ReStructuredText
Servers
|
|
=======
|
|
|
|
A virtual machine instance.
|
|
|
|
Classes
|
|
-------
|
|
|
|
.. currentmodule:: cinderclient
|
|
|
|
.. autoclass:: ServerManager
|
|
:members: get, list, find, findall, create, update, delete, share_ip,
|
|
unshare_ip, reboot, rebuild, resize, confirm_resize,
|
|
revert_resize
|
|
|
|
.. autoclass:: Server
|
|
:members: update, delete, share_ip, unshare_ip, reboot, rebuild, resize,
|
|
confirm_resize, revert_resize
|
|
|
|
.. attribute:: id
|
|
|
|
This server's ID.
|
|
|
|
.. attribute:: name
|
|
|
|
The name you gave the server when you booted it.
|
|
|
|
.. attribute:: imageId
|
|
|
|
The :class:`Image` this server was booted with.
|
|
|
|
.. attribute:: flavorId
|
|
|
|
This server's current :class:`Flavor`.
|
|
|
|
.. attribute:: hostId
|
|
|
|
Rackspace doesn't document this value. It appears to be SHA1 hash.
|
|
|
|
.. attribute:: status
|
|
|
|
The server's status (``BOOTING``, ``ACTIVE``, etc).
|
|
|
|
.. attribute:: progress
|
|
|
|
When booting, resizing, updating, etc., this will be set to a
|
|
value between 0 and 100 giving a rough estimate of the progress
|
|
of the current operation.
|
|
|
|
.. attribute:: addresses
|
|
|
|
The public and private IP addresses of this server. This'll be a dict
|
|
of the form::
|
|
|
|
{
|
|
"public" : ["67.23.10.138"],
|
|
"private" : ["10.176.42.19"]
|
|
}
|
|
|
|
You *can* get more than one public/private IP provisioned, but not
|
|
directly from the API; you'll need to open a support ticket.
|
|
|
|
.. attribute:: metadata
|
|
|
|
The metadata dict you gave when creating the server.
|
|
|
|
Constants
|
|
---------
|
|
|
|
Reboot types:
|
|
|
|
.. data:: REBOOT_SOFT
|
|
.. data:: REBOOT_HARD
|