You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2013/09/28 13:17:45 UTC
[3/6] Migrate API docstrings to Sphinx format.
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/opennebula.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/opennebula.py b/libcloud/compute/drivers/opennebula.py
index cf30e74..2b14528 100644
--- a/libcloud/compute/drivers/opennebula.py
+++ b/libcloud/compute/drivers/opennebula.py
@@ -125,8 +125,8 @@ class OpenNebulaResponse(XmlResponse):
Check if response has the appropriate HTTP response code to be a
success.
- @rtype: C{bool}
- @return: True is success, else False.
+ :rtype: ``bool``
+ :return: True is success, else False.
"""
i = int(self.status)
return i >= 200 and i <= 299
@@ -135,10 +135,10 @@ class OpenNebulaResponse(XmlResponse):
"""
Check if response contains any errors.
- @raise: L{InvalidCredsError}
+ @raise: :class:`InvalidCredsError`
- @rtype: C{ElementTree}
- @return: Contents of HTTP response body.
+ :rtype: :class:`ElementTree`
+ :return: Contents of HTTP response body.
"""
if int(self.status) == httplib.UNAUTHORIZED:
raise InvalidCredsError(self.body)
@@ -169,11 +169,11 @@ class OpenNebulaConnection(ConnectionUserAndKey):
Includes adding Basic HTTP Authorization headers for authenticating
against the OpenNebula.org OCCI interface.
- @type headers: C{dict}
- @param headers: Dictionary containing HTTP headers.
+ :type headers: ``dict``
+ :param headers: Dictionary containing HTTP headers.
- @rtype: C{dict}
- @return: Dictionary containing updated headers.
+ :rtype: ``dict``
+ :return: Dictionary containing updated headers.
"""
if self.plain_auth:
passwd = self.key
@@ -257,8 +257,8 @@ class OpenNebulaNetwork(object):
Note, for example, that this example will always produce the
same UUID!
- @rtype: C{string}
- @return: Unique identifier for this instance.
+ :rtype: ``str``
+ :return: Unique identifier for this instance.
"""
return hashlib.sha1(b("%s:%s" % (self.id,
self.driver.type))).hexdigest()
@@ -319,12 +319,12 @@ class OpenNebulaNodeDriver(NodeDriver):
"""
Create a new OpenNebula node.
- @inherits: L{NodeDriver.create_node}
+ @inherits: :class:`NodeDriver.create_node`
- @keyword networks: List of virtual networks to which this node should
+ :keyword networks: List of virtual networks to which this node should
connect. (optional)
- @type networks: L{OpenNebulaNetwork} or
- C{list} of L{OpenNebulaNetwork}
+ :type networks: :class:`OpenNebulaNetwork` or
+ ``list`` of :class:`OpenNebulaNetwork`
"""
compute = ET.Element('COMPUTE')
@@ -375,10 +375,10 @@ class OpenNebulaNodeDriver(NodeDriver):
"""
Return list of sizes on a provider.
- @inherits: L{NodeDriver.list_sizes}
+ @inherits: :class:`NodeDriver.list_sizes`
- @return: List of compute node sizes supported by the cloud provider.
- @rtype: C{list} of L{OpenNebulaNodeSize}
+ :return: List of compute node sizes supported by the cloud provider.
+ :rtype: ``list`` of :class:`OpenNebulaNodeSize`
"""
return [
NodeSize(id=1,
@@ -411,13 +411,13 @@ class OpenNebulaNodeDriver(NodeDriver):
"""
List virtual networks on a provider.
- @type location: L{NodeLocation}
- @param location: Location from which to request a list of virtual
+ :type location: :class:`NodeLocation`
+ :param location: Location from which to request a list of virtual
networks. (optional)
- @return: List of virtual networks available to be connected to a
+ :return: List of virtual networks available to be connected to a
compute node.
- @rtype: C{list} of L{OpenNebulaNetwork}
+ :rtype: ``list`` of :class:`OpenNebulaNetwork`
"""
return self._to_networks(self.connection.request('/network').object)
@@ -429,15 +429,15 @@ class OpenNebulaNodeDriver(NodeDriver):
action which should be carried out on that compute node. Then
instruct the node to carry out that action.
- @param node: Compute node instance.
- @type node: L{Node}
+ :param node: Compute node instance.
+ :type node: :class:`Node`
- @param action: Action to be carried out on the compute node.
- @type action: C{str}
+ :param action: Action to be carried out on the compute node.
+ :type action: ``str``
- @return: False if an HTTP Bad Request is received, else, True is
+ :return: False if an HTTP Bad Request is received, else, True is
returned.
- @rtype: C{bool}
+ :rtype: ``bool``
"""
compute_node_id = str(node.id)
@@ -469,8 +469,8 @@ class OpenNebulaNodeDriver(NodeDriver):
issue a request to convert each XML object representation of an image
to a NodeImage object.
- @rtype: C{list} of L{NodeImage}
- @return: List of images.
+ :rtype: ``list`` of :class:`NodeImage`
+ :return: List of images.
"""
images = []
for element in object.findall('DISK'):
@@ -486,11 +486,11 @@ class OpenNebulaNodeDriver(NodeDriver):
Take XML object containing an image description and convert to
NodeImage object.
- @type image: L{ElementTree}
- @param image: XML representation of an image.
+ :type image: :class:`ElementTree`
+ :param image: XML representation of an image.
- @rtype: L{NodeImage}
- @return: The newly extracted L{NodeImage}.
+ :rtype: :class:`NodeImage`
+ :return: The newly extracted :class:`NodeImage`.
"""
return NodeImage(id=image.findtext('ID'),
name=image.findtext('NAME'),
@@ -507,8 +507,8 @@ class OpenNebulaNodeDriver(NodeDriver):
issue a request to convert each XML object representation of a network
to an OpenNebulaNetwork object.
- @rtype: C{list} of L{OpenNebulaNetwork}
- @return: List of virtual networks.
+ :rtype: ``list`` of :class:`OpenNebulaNetwork`
+ :return: List of virtual networks.
"""
networks = []
for element in object.findall('NETWORK'):
@@ -527,8 +527,8 @@ class OpenNebulaNodeDriver(NodeDriver):
Take XML representation containing a network description and
convert to OpenNebulaNetwork object.
- @rtype: L{OpenNebulaNetwork}
- @return: The newly extracted L{OpenNebulaNetwork}.
+ :rtype: :class:`OpenNebulaNetwork`
+ :return: The newly extracted :class:`OpenNebulaNetwork`.
"""
return OpenNebulaNetwork(id=element.findtext('ID'),
name=element.findtext('NAME'),
@@ -545,8 +545,8 @@ class OpenNebulaNodeDriver(NodeDriver):
issue a request to convert each XML object representation of a node
to a Node object.
- @rtype: C{list} of L{Node}
- @return: A list of compute nodes.
+ :rtype: ``list`` of :class:`Node`
+ :return: A list of compute nodes.
"""
computes = []
for element in object.findall('COMPUTE'):
@@ -565,11 +565,11 @@ class OpenNebulaNodeDriver(NodeDriver):
Take XML representation containing a compute node description and
convert to Node object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: L{Node}
- @return: The newly extracted L{Node}.
+ :rtype: :class:`Node`
+ :return: The newly extracted :class:`Node`.
"""
try:
state = self.NODE_STATE_MAP[compute.findtext('STATE').upper()]
@@ -591,11 +591,11 @@ class OpenNebulaNodeDriver(NodeDriver):
Extract network descriptions from a compute node XML representation,
converting each network to an OpenNebulaNetwork object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: C{list} of L{OpenNebulaNetwork}s.
- @return: List of virtual networks attached to the compute node.
+ :rtype: ``list`` of :class:`OpenNebulaNetwork`s.
+ :return: List of virtual networks attached to the compute node.
"""
networks = list()
@@ -617,11 +617,11 @@ class OpenNebulaNodeDriver(NodeDriver):
Extract image disk descriptions from a compute node XML representation,
converting the disks to an NodeImage object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: L{NodeImage}.
- @return: First disk attached to a compute node.
+ :rtype: :class:`NodeImage`.
+ :return: First disk attached to a compute node.
"""
disks = list()
@@ -660,19 +660,19 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
"""
Create a new OpenNebula node.
- @inherits: L{NodeDriver.create_node}
+ @inherits: :class:`NodeDriver.create_node`
- @keyword networks: List of virtual networks to which this node should
+ :keyword networks: List of virtual networks to which this node should
connect. (optional)
- @type networks: L{OpenNebulaNetwork} or C{list}
- of L{OpenNebulaNetwork}
+ :type networks: :class:`OpenNebulaNetwork` or ``list``
+ of :class:`OpenNebulaNetwork`
- @keyword context: Custom (key, value) pairs to be injected into
+ :keyword context: Custom (key, value) pairs to be injected into
compute node XML description. (optional)
- @type context: C{dict}
+ :type context: ``dict``
- @return: Instance of a newly created node.
- @rtype: L{Node}
+ :return: Instance of a newly created node.
+ :rtype: :class:`Node`
"""
compute = ET.Element('COMPUTE')
@@ -722,10 +722,10 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
"""
Return list of sizes on a provider.
- @inherits: L{NodeDriver.list_sizes}
+ @inherits: :class:`NodeDriver.list_sizes`
- @return: List of compute node sizes supported by the cloud provider.
- @rtype: C{list} of L{OpenNebulaNodeSize}
+ :return: List of compute node sizes supported by the cloud provider.
+ :rtype: ``list`` of :class:`OpenNebulaNodeSize`
"""
return [
OpenNebulaNodeSize(id=1,
@@ -771,8 +771,8 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
issue a request to convert each XML object representation of an image
to a NodeImage object.
- @rtype: C{list} of L{NodeImage}
- @return: List of images.
+ :rtype: ``list`` of :class:`NodeImage`
+ :return: List of images.
"""
images = []
for element in object.findall('STORAGE'):
@@ -788,11 +788,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
Take XML object containing an image description and convert to
NodeImage object.
- @type image: L{ElementTree}
- @param image: XML representation of an image.
+ :type image: :class:`ElementTree`
+ :param image: XML representation of an image.
- @rtype: L{NodeImage}
- @return: The newly extracted L{NodeImage}.
+ :rtype: :class:`NodeImage`
+ :return: The newly extracted :class:`NodeImage`.
"""
return NodeImage(id=image.findtext('ID'),
name=image.findtext('NAME'),
@@ -810,11 +810,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
Take XML representation containing a compute node description and
convert to Node object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: L{Node}
- @return: The newly extracted L{Node}.
+ :rtype: :class:`Node`
+ :return: The newly extracted :class:`Node`.
"""
try:
state = self.NODE_STATE_MAP[compute.findtext('STATE').upper()]
@@ -838,11 +838,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
Extract network descriptions from a compute node XML representation,
converting each network to an OpenNebulaNetwork object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: C{list} of L{OpenNebulaNetwork}
- @return: List of virtual networks attached to the compute node.
+ :rtype: ``list`` of :class:`OpenNebulaNetwork`
+ :return: List of virtual networks attached to the compute node.
"""
networks = []
@@ -867,11 +867,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
Extract image disk descriptions from a compute node XML representation,
converting the disks to an NodeImage object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: C{list} of L{NodeImage}
- @return: Disks attached to a compute node.
+ :rtype: ``list`` of :class:`NodeImage`
+ :return: Disks attached to a compute node.
"""
disks = list()
@@ -908,11 +908,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
Extract node size, or node type, description from a compute node XML
representation, converting the node size to a NodeSize object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: L{OpenNebulaNodeSize}
- @return: Node type of compute node.
+ :rtype: :class:`OpenNebulaNodeSize`
+ :return: Node type of compute node.
"""
instance_type = compute.find('INSTANCE_TYPE')
@@ -929,11 +929,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebulaNodeDriver):
Extract node size, or node type, description from a compute node XML
representation, converting the node size to a NodeSize object.
- @type compute: L{ElementTree}
- @param compute: XML representation of a compute node.
+ :type compute: :class:`ElementTree`
+ :param compute: XML representation of a compute node.
- @rtype: C{dict}
- @return: Dictionary containing (key, value) pairs related to
+ :rtype: ``dict``
+ :return: Dictionary containing (key, value) pairs related to
compute node context.
"""
contexts = dict()
@@ -959,16 +959,16 @@ class OpenNebula_3_0_NodeDriver(OpenNebula_2_0_NodeDriver):
which will be saved, and the name under which the image will be saved
upon shutting down the compute node.
- @param node: Compute node instance.
- @type node: L{Node}
+ :param node: Compute node instance.
+ :type node: :class:`Node`
- @param name: Name under which the image should be saved after shutting
+ :param name: Name under which the image should be saved after shutting
down the compute node.
- @type name: C{str}
+ :type name: ``str``
- @return: False if an HTTP Bad Request is received, else, True is
+ :return: False if an HTTP Bad Request is received, else, True is
returned.
- @rtype: C{bool}
+ :rtype: ``bool``
"""
compute_node_id = str(node.id)
@@ -1004,8 +1004,8 @@ class OpenNebula_3_0_NodeDriver(OpenNebula_2_0_NodeDriver):
Take XML representation containing a network description and
convert to OpenNebulaNetwork object.
- @return: The newly extracted L{OpenNebulaNetwork}.
- @rtype: L{OpenNebulaNetwork}
+ :return: The newly extracted :class:`OpenNebulaNetwork`.
+ :rtype: :class:`OpenNebulaNetwork`
"""
return OpenNebulaNetwork(id=element.findtext('ID'),
name=element.findtext('NAME'),
@@ -1027,10 +1027,10 @@ class OpenNebula_3_2_NodeDriver(OpenNebula_3_0_NodeDriver):
"""
Return list of sizes on a provider.
- @inherits: L{NodeDriver.list_sizes}
+ @inherits: :class:`NodeDriver.list_sizes`
- @return: List of compute node sizes supported by the cloud provider.
- @rtype: C{list} of L{OpenNebulaNodeSize}
+ :return: List of compute node sizes supported by the cloud provider.
+ :rtype: ``list`` of :class:`OpenNebulaNodeSize`
"""
return self._to_sizes(self.connection.request('/instance_type').object)
@@ -1043,8 +1043,8 @@ class OpenNebula_3_2_NodeDriver(OpenNebula_3_0_NodeDriver):
and issue a request to convert each XML object representation of an
instance type to an OpenNebulaNodeSize object.
- @return: List of instance types.
- @rtype: C{list} of L{OpenNebulaNodeSize}
+ :return: List of instance types.
+ :rtype: ``list`` of :class:`OpenNebulaNodeSize`
"""
sizes = []
size_id = 1
@@ -1214,8 +1214,8 @@ class OpenNebula_3_8_NodeDriver(OpenNebula_3_6_NodeDriver):
and issue a request to convert each XML object representation of an
instance type to an OpenNebulaNodeSize object.
- @return: List of instance types.
- @rtype: C{list} of L{OpenNebulaNodeSize}
+ :return: List of instance types.
+ :rtype: ``list`` of :class:`OpenNebulaNodeSize`
"""
sizes = []
size_id = 1
@@ -1241,9 +1241,9 @@ class OpenNebula_3_8_NodeDriver(OpenNebula_3_6_NodeDriver):
def _ex_connection_class_kwargs(self):
"""
- Set plain_auth as an extra L{OpenNebulaConnection_3_8} argument
+ Set plain_auth as an extra :class:`OpenNebulaConnection_3_8` argument
- @return: C{dict} of L{OpenNebulaConnection_3_8} input arguments
+ :return: ``dict`` of :class:`OpenNebulaConnection_3_8` input arguments
"""
return {'plain_auth': self.plain_auth}
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/openstack.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/openstack.py b/libcloud/compute/drivers/openstack.py
index 914a9a6..23ea906 100644
--- a/libcloud/compute/drivers/openstack.py
+++ b/libcloud/compute/drivers/openstack.py
@@ -280,10 +280,10 @@ class OpenStackNodeDriver(NodeDriver, OpenStackDriverMixin):
def list_images(self, location=None, ex_only_active=True):
"""
- @inherits: L{NodeDriver.list_images}
+ @inherits: :class:`NodeDriver.list_images`
- @param ex_only_active: True if list only active
- @type ex_only_active: C{bool}
+ :param ex_only_active: True if list only active
+ :type ex_only_active: ``bool``
"""
return self._to_images(
@@ -303,10 +303,10 @@ class OpenStackNodeDriver(NodeDriver, OpenStackDriverMixin):
"""
Lists details of the specified server.
- @param node_id: ID of the node which should be used
- @type node_id: C{str}
+ :param node_id: ID of the node which should be used
+ :type node_id: ``str``
- @rtype: L{Node}
+ :rtype: :class:`Node`
"""
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
@@ -323,10 +323,10 @@ class OpenStackNodeDriver(NodeDriver, OpenStackDriverMixin):
"""
Soft reboots the specified server
- @param node: node
- @type node: L{Node}
+ :param node: node
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
return self._reboot_node(node, reboot_type='SOFT')
@@ -334,10 +334,10 @@ class OpenStackNodeDriver(NodeDriver, OpenStackDriverMixin):
"""
Hard reboots the specified server
- @param node: node
- @type node: L{Node}
+ :param node: node
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
return self._reboot_node(node, reboot_type='HARD')
@@ -451,18 +451,18 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Create a new node
- @inherits: L{NodeDriver.create_node}
+ @inherits: :class:`NodeDriver.create_node`
- @keyword ex_metadata: Key/Value metadata to associate with a node
- @type ex_metadata: C{dict}
+ :keyword ex_metadata: Key/Value metadata to associate with a node
+ :type ex_metadata: ``dict``
- @keyword ex_files: File Path => File contents to create on
+ :keyword ex_files: File Path => File contents to create on
the node
- @type ex_files: C{dict}
+ :type ex_files: ``dict``
- @keyword ex_shared_ip_group_id: The server is launched into
+ :keyword ex_shared_ip_group_id: The server is launched into
that shared IP group
- @type ex_shared_ip_group_id: C{str}
+ :type ex_shared_ip_group_id: ``str``
"""
name = kwargs['name']
image = kwargs['image']
@@ -505,16 +505,16 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
This will reboot the instance to complete the operation.
- L{Node.extra['password']} will be set to the new value if the
+ :class:`Node.extra['password']` will be set to the new value if the
operation was successful.
- @param node: node to set password
- @type node: L{Node}
+ :param node: node to set password
+ :type node: :class:`Node`
- @param password: new password.
- @type password: C{str}
+ :param password: new password.
+ :type password: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
return self._change_password_or_name(node, password=password)
@@ -524,13 +524,13 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
This will reboot the instance to complete the operation.
- @param node: node to set name
- @type node: L{Node}
+ :param node: node to set name
+ :type node: :class:`Node`
- @param name: new name
- @type name: C{str}
+ :param name: new name
+ :type name: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
return self._change_password_or_name(node, name=name)
@@ -538,13 +538,13 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Change an existing server flavor / scale the server up or down.
- @param node: node to resize.
- @type node: L{Node}
+ :param node: node to resize.
+ :type node: :class:`Node`
- @param size: new size.
- @type size: L{NodeSize}
+ :param size: new size.
+ :type size: :class:`NodeSize`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
elm = ET.Element(
'resize',
@@ -565,10 +565,10 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
For more info refer to the API documentation: http://goo.gl/zjFI1
- @param node: node for which the resize request will be confirmed.
- @type node: L{Node}
+ :param node: node for which the resize request will be confirmed.
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
elm = ET.Element(
'confirmResize',
@@ -588,10 +588,10 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
For more info refer to the API documentation: http://goo.gl/AizBu
- @param node: node for which the resize request will be reverted.
- @type node: L{Node}
+ :param node: node for which the resize request will be reverted.
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
elm = ET.Element(
'revertResize',
@@ -607,13 +607,13 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Rebuilds the specified server.
- @param node_id: ID of the node which should be used
- @type node_id: C{str}
+ :param node_id: ID of the node which should be used
+ :type node_id: ``str``
- @param image_id: ID of the image which should be used
- @type image_id: C{str}
+ :param image_id: ID of the image which should be used
+ :type image_id: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
# @TODO: Remove those ifs in 0.6
if isinstance(node_id, Node):
@@ -637,13 +637,13 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Creates a shared IP group.
- @param group_name: group name which should be used
- @type group_name: C{str}
+ :param group_name: group name which should be used
+ :type group_name: ``str``
- @param node_id: ID of the node which should be used
- @type node_id: C{str}
+ :param node_id: ID of the node which should be used
+ :type node_id: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
@@ -672,10 +672,10 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
Lists IDs and names for shared IP groups.
If details lists all details for shared IP groups.
- @param details: True if details is required
- @type details: C{bool}
+ :param details: True if details is required
+ :type details: ``bool``
- @rtype: C{list} of L{OpenStack_1_0_SharedIpGroup}
+ :rtype: ``list`` of :class:`OpenStack_1_0_SharedIpGroup`
"""
uri = '/shared_ip_groups/detail' if details else '/shared_ip_groups'
resp = self.connection.request(uri,
@@ -688,10 +688,10 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Deletes the specified shared IP group.
- @param group_id: group id which should be used
- @type group_id: C{str}
+ :param group_id: group id which should be used
+ :type group_id: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
uri = '/shared_ip_groups/%s' % group_id
resp = self.connection.request(uri, method='DELETE')
@@ -701,19 +701,19 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Shares an IP address to the specified server.
- @param group_id: group id which should be used
- @type group_id: C{str}
+ :param group_id: group id which should be used
+ :type group_id: ``str``
- @param node_id: ID of the node which should be used
- @type node_id: C{str}
+ :param node_id: ID of the node which should be used
+ :type node_id: ``str``
- @param ip: ip which should be used
- @type ip: C{str}
+ :param ip: ip which should be used
+ :type ip: ``str``
- @param configure_node: configure node
- @type configure_node: C{bool}
+ :param configure_node: configure node
+ :type configure_node: ``bool``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
@@ -742,13 +742,13 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
Removes a shared IP address from the specified server.
- @param node_id: ID of the node which should be used
- @type node_id: C{str}
+ :param node_id: ID of the node which should be used
+ :type node_id: ``str``
- @param ip: ip which should be used
- @type ip: C{str}
+ :param ip: ip which should be used
+ :type ip: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
@@ -764,10 +764,10 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
"""
List all server addresses.
- @param node_id: ID of the node which should be used
- @type node_id: C{str}
+ :param node_id: ID of the node which should be used
+ :type node_id: ``str``
- @rtype: C{OpenStack_1_0_NodeIpAddresses}
+ :rtype: :class:`OpenStack_1_0_NodeIpAddresses`
"""
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
@@ -882,8 +882,8 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
and absolute limits like total amount of available
RAM to be used by servers.
- @return: dict with keys 'rate' and 'absolute'
- @rtype: C{dict}
+ :return: dict with keys 'rate' and 'absolute'
+ :rtype: ``dict``
"""
def _to_rate(el):
@@ -909,13 +909,13 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
def ex_save_image(self, node, name):
"""Create an image for node.
- @param node: node to use as a base for image
- @type node: L{Node}
+ :param node: node to use as a base for image
+ :type node: :class:`Node`
- @param name: name for new image
- @type name: C{str}
+ :param name: name for new image
+ :type name: ``str``
- @rtype: L{NodeImage}
+ :rtype: :class:`NodeImage`
"""
image_elm = ET.Element(
@@ -932,10 +932,10 @@ class OpenStack_1_0_NodeDriver(OpenStackNodeDriver):
def ex_delete_image(self, image):
"""Delete an image for node.
- @param image: the image to be deleted
- @type image: L{NodeImage}
+ :param image: the image to be deleted
+ :type image: :class:`NodeImage`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
uri = '/images/%s' % image.id
resp = self.connection.request(uri, method='DELETE')
@@ -1028,25 +1028,25 @@ class OpenStackSecurityGroup(object):
"""
Constructor.
- @keyword id: Group id.
- @type id: C{str}
+ :keyword id: Group id.
+ :type id: ``str``
- @keyword tenant_id: Owner of the security group.
- @type tenant_id: C{str}
+ :keyword tenant_id: Owner of the security group.
+ :type tenant_id: ``str``
- @keyword name: Human-readable name for the security group. Might
+ :keyword name: Human-readable name for the security group. Might
not be unique.
- @type name: C{str}
+ :type name: ``str``
- @keyword description: Human-readable description of a security
+ :keyword description: Human-readable description of a security
group.
- @type description: C{str}
+ :type description: ``str``
- @keyword rules: Rules associated with this group.
- @type description: C{list} of L{OpenStackSecurityGroupRule}
+ :keyword rules: Rules associated with this group.
+ :type description: ``list`` of :class:`OpenStackSecurityGroupRule`
- @keyword extra: Extra attributes associated with this group.
- @type extra: C{dict}
+ :keyword extra: Extra attributes associated with this group.
+ :type extra: ``dict``
"""
self.id = id
self.tenant_id = tenant_id
@@ -1073,32 +1073,32 @@ class OpenStackSecurityGroupRule(object):
"""
Constructor.
- @keyword id: Rule id.
- @type id: C{str}
+ :keyword id: Rule id.
+ :type id: ``str``
- @keyword parent_group_id: ID of the parent security group.
- @type parent_group_id: C{str}
+ :keyword parent_group_id: ID of the parent security group.
+ :type parent_group_id: ``str``
- @keyword ip_protocol: IP Protocol (icmp, tcp, udp, etc).
- @type ip_protocol: C{str}
+ :keyword ip_protocol: IP Protocol (icmp, tcp, udp, etc).
+ :type ip_protocol: ``str``
- @keyword from_port: Port at start of range.
- @type from_port: C{int}
+ :keyword from_port: Port at start of range.
+ :type from_port: ``int``
- @keyword to_port: Port at end of range.
- @type to_port: C{int}
+ :keyword to_port: Port at end of range.
+ :type to_port: ``int``
- @keyword ip_range: CIDR for address range.
- @type ip_range: C{str}
+ :keyword ip_range: CIDR for address range.
+ :type ip_range: ``str``
- @keyword group: Name of a source security group to apply to rule.
- @type group: C{str}
+ :keyword group: Name of a source security group to apply to rule.
+ :type group: ``str``
- @keyword tenant_id: Owner of the security group.
- @type tenant_id: C{str}
+ :keyword tenant_id: Owner of the security group.
+ :type tenant_id: ``str``
- @keyword extra: Extra attributes associated with this rule.
- @type extra: C{dict}
+ :keyword extra: Extra attributes associated with this rule.
+ :type extra: ``dict``
"""
self.id = id
self.parent_group_id = parent_group_id
@@ -1134,20 +1134,20 @@ class OpenStackKeyPair(object):
"""
Constructor.
- @keyword name: Name of the KeyPair.
- @type name: C{str}
+ :keyword name: Name of the KeyPair.
+ :type name: ``str``
- @keyword fingerprint: Fingerprint of the KeyPair
- @type fingerprint: C{str}
+ :keyword fingerprint: Fingerprint of the KeyPair
+ :type fingerprint: ``str``
- @keyword public_key: Public key in OpenSSH format.
- @type public_key: C{str}
+ :keyword public_key: Public key in OpenSSH format.
+ :type public_key: ``str``
- @keyword private_key: Private key in PEM format.
- @type private_key: C{str}
+ :keyword private_key: Private key in PEM format.
+ :type private_key: ``str``
- @keyword extra: Extra attributes associated with this KeyPair.
- @type extra: C{dict}
+ :keyword extra: Extra attributes associated with this KeyPair.
+ :type extra: ``dict``
"""
self.name = name
self.fingerprint = fingerprint
@@ -1187,30 +1187,30 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
def create_node(self, **kwargs):
"""Create a new node
- @inherits: L{NodeDriver.create_node}
+ @inherits: :class:`NodeDriver.create_node`
- @keyword ex_metadata: Key/Value metadata to associate with a node
- @type ex_metadata: C{dict}
+ :keyword ex_metadata: Key/Value metadata to associate with a node
+ :type ex_metadata: ``dict``
- @keyword ex_files: File Path => File contents to create on
+ :keyword ex_files: File Path => File contents to create on
the no de
- @type ex_files: C{dict}
+ :type ex_files: ``dict``
- @keyword ex_keyname: Name of existing public key to inject into
+ :keyword ex_keyname: Name of existing public key to inject into
instance
- @type ex_keyname: C{str}
+ :type ex_keyname: ``str``
- @keyword ex_userdata: String containing user data
+ :keyword ex_userdata: String containing user data
see
https://help.ubuntu.com/community/CloudInit
- @type ex_userdata: C{str}
+ :type ex_userdata: ``str``
- @keyword networks: The server is launched into a set of Networks.
- @type networks: L{OpenStackNetwork}
+ :keyword networks: The server is launched into a set of Networks.
+ :type networks: :class:`OpenStackNetwork`
- @keyword ex_security_groups: List of security groups to assign to
+ :keyword ex_security_groups: List of security groups to assign to
the node
- @type ex_security_groups: C{list} of L{OpenStackSecurityGroup}
+ :type ex_security_groups: ``list`` of :class:`OpenStackSecurityGroup`
"""
server_params = self._create_args_to_params(None, **kwargs)
@@ -1329,13 +1329,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Changes the administrator password for a specified server.
- @param node: Node to rebuild.
- @type node: L{Node}
+ :param node: Node to rebuild.
+ :type node: :class:`Node`
- @param password: The administrator password.
- @type password: C{str}
+ :param password: The administrator password.
+ :type password: ``str``
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self._node_action(node, 'changePassword', adminPass=password)
node.extra['password'] = password
@@ -1345,13 +1345,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Rebuild a Node.
- @param node: Node to rebuild.
- @type node: L{Node}
+ :param node: Node to rebuild.
+ :type node: :class:`Node`
- @param image: New image to use.
- @type image: L{NodeImage}
+ :param image: New image to use.
+ :type image: :class:`NodeImage`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
server_params = self._create_args_to_params(node, image=image)
resp = self._node_action(node, 'rebuild', **server_params)
@@ -1361,13 +1361,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Change a node size.
- @param node: Node to resize.
- @type node: L{Node}
+ :param node: Node to resize.
+ :type node: :class:`Node`
- @type size: L{NodeSize}
- @param size: New size to use.
+ :type size: :class:`NodeSize`
+ :param size: New size to use.
- @rtype: C{bool}
+ :rtype: ``bool``
"""
server_params = self._create_args_to_params(node, size=size)
resp = self._node_action(node, 'resize', **server_params)
@@ -1377,10 +1377,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Confirms a pending resize action.
- @param node: Node to resize.
- @type node: L{Node}
+ :param node: Node to resize.
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self._node_action(node, 'confirmResize')
return resp.status == httplib.NO_CONTENT
@@ -1389,10 +1389,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Cancels and reverts a pending resize action.
- @param node: Node to resize.
- @type node: L{Node}
+ :param node: Node to resize.
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self._node_action(node, 'revertResize')
return resp.status == httplib.ACCEPTED
@@ -1401,16 +1401,16 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Creates a new image.
- @param node: Node
- @type node: L{Node}
+ :param node: Node
+ :type node: :class:`Node`
- @param name: The name for the new image.
- @type name: C{str}
+ :param name: The name for the new image.
+ :type name: ``str``
- @param metadata: Key and value pairs for metadata.
- @type metadata: C{dict}
+ :param metadata: Key and value pairs for metadata.
+ :type metadata: ``dict``
- @rtype: L{NodeImage}
+ :rtype: :class:`NodeImage`
"""
optional_params = {}
if metadata:
@@ -1424,13 +1424,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Sets the Node's name.
- @param node: Node
- @type node: L{Node}
+ :param node: Node
+ :type node: :class:`Node`
- @param name: The name of the server.
- @type name: C{str}
+ :param name: The name of the server.
+ :type name: ``str``
- @rtype: L{Node}
+ :rtype: :class:`Node`
"""
return self._update_node(node, name=name)
@@ -1438,11 +1438,11 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a Node's metadata.
- @param node: Node
- @type node: L{Node}
+ :param node: Node
+ :type node: :class:`Node`
- @return: Key/Value metadata associated with node.
- @rtype: C{dict}
+ :return: Key/Value metadata associated with node.
+ :rtype: ``dict``
"""
return self.connection.request(
'/servers/%s/metadata' % (node.id,),
@@ -1452,13 +1452,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Sets the Node's metadata.
- @param node: Node
- @type node: L{Node}
+ :param node: Node
+ :type node: :class:`Node`
- @param metadata: Key/Value metadata to associate with a node
- @type metadata: C{dict}
+ :param metadata: Key/Value metadata to associate with a node
+ :type metadata: ``dict``
- @rtype: C{dict}
+ :rtype: ``dict``
"""
return self.connection.request(
'/servers/%s/metadata' % (node.id,), method='PUT',
@@ -1472,13 +1472,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
The driver currently only supports updating the node name.
- @param node: Node
- @type node: L{Node}
+ :param node: Node
+ :type node: :class:`Node`
- @keyword name: New name for the server
- @type name: C{str}
+ :keyword name: New name for the server
+ :type name: ``str``
- @rtype: L{Node}
+ :rtype: :class:`Node`
"""
potential_data = self._create_args_to_params(node, **node_updates)
updates = {'name': potential_data['name']}
@@ -1498,7 +1498,7 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a list of Networks that are available.
- @rtype: C{list} of L{OpenStackNetwork}
+ :rtype: ``list`` of :class:`OpenStackNetwork`
"""
return self._to_networks(
self.connection.request('/os-networksv2').object)
@@ -1507,13 +1507,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Create a new Network
- @param name: Name of network which should be used
- @type name: C{str}
+ :param name: Name of network which should be used
+ :type name: ``str``
- @param cidr: cidr of network which should be used
- @type cidr: C{str}
+ :param cidr: cidr of network which should be used
+ :type cidr: ``str``
- @rtype: L{OpenStackNetwork}
+ :rtype: :class:`OpenStackNetwork`
"""
return self._to_network(self.connection.request(
'/os-networksv2', method='POST',
@@ -1524,10 +1524,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a list of NodeNetorks that are available.
- @param network: Network which should be used
- @type network: L{OpenStackNetwork}
+ :param network: Network which should be used
+ :type network: :class:`OpenStackNetwork`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self.connection.request('/os-networksv2/%s' % (network.id),
method='DELETE')
@@ -1574,7 +1574,7 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a list of Security Groups that are available.
- @rtype: C{list} of L{OpenStackSecurityGroup}
+ :rtype: ``list`` of :class:`OpenStackSecurityGroup`
"""
return self._to_security_groups(
self.connection.request('/os-security-groups').object)
@@ -1583,7 +1583,7 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get Security Groups of the specified server.
- @rtype: C{list} of L{OpenStackSecurityGroup}
+ :rtype: ``list`` of :class:`OpenStackSecurityGroup`
"""
return self._to_security_groups(
self.connection.request('/servers/%s/os-security-groups' %
@@ -1593,13 +1593,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Create a new Security Group
- @param name: Name of the new Security Group
- @type name: C{str}
+ :param name: Name of the new Security Group
+ :type name: ``str``
- @param description: Description of the new Security Group
- @type description: C{str}
+ :param description: Description of the new Security Group
+ :type description: ``str``
- @rtype: L{OpenStackSecurityGroup}
+ :rtype: :class:`OpenStackSecurityGroup`
"""
return self._to_security_group(self.connection.request(
'/os-security-groups', method='POST',
@@ -1610,10 +1610,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Delete a Security Group.
- @param security_group: Security Group should be deleted
- @type security_group: L{OpenStackSecurityGroup}
+ :param security_group: Security Group should be deleted
+ :type security_group: :class:`OpenStackSecurityGroup`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self.connection.request('/os-security-groups/%s' %
(security_group.id),
@@ -1626,27 +1626,27 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Create a new Rule in a Security Group
- @param security_group: Security Group in which to add the rule
- @type security_group: L{OpenStackSecurityGroup}
+ :param security_group: Security Group in which to add the rule
+ :type security_group: :class:`OpenStackSecurityGroup`
- @param ip_protocol: Protocol to which this rule applies
+ :param ip_protocol: Protocol to which this rule applies
Examples: tcp, udp, ...
- @type ip_protocol: C{str}
+ :type ip_protocol: ``str``
- @param from_port: First port of the port range
- @type from_port: C{int}
+ :param from_port: First port of the port range
+ :type from_port: ``int``
- @param to_port: Last port of the port range
- @type to_port: C{int}
+ :param to_port: Last port of the port range
+ :type to_port: ``int``
- @param cidr: CIDR notation of the source IP range for this rule
- @type cidr: C{str}
+ :param cidr: CIDR notation of the source IP range for this rule
+ :type cidr: ``str``
- @param source_security_group: Existing Security Group to use as the
+ :param source_security_group: Existing Security Group to use as the
source (instead of CIDR)
- @type source_security_group: L{OpenStackSecurityGroup
+ :type source_security_group: L{OpenStackSecurityGroup
- @rtype: L{OpenStackSecurityGroupRule}
+ :rtype: :class:`OpenStackSecurityGroupRule`
"""
source_security_group_id = None
if type(source_security_group) == OpenStackSecurityGroup:
@@ -1667,10 +1667,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Delete a Rule from a Security Group.
- @param rule: Rule should be deleted
- @type rule: L{OpenStackSecurityGroupRule}
+ :param rule: Rule should be deleted
+ :type rule: :class:`OpenStackSecurityGroupRule`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self.connection.request('/os-security-group-rules/%s' %
(rule.id), method='DELETE')
@@ -1691,7 +1691,7 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a list of KeyPairs that are available.
- @rtype: C{list} of L{OpenStackKeyPair}
+ :rtype: ``list`` of :class:`OpenStackKeyPair`
"""
return self._to_keypairs(
self.connection.request('/os-keypairs').object)
@@ -1700,10 +1700,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Create a new KeyPair
- @param name: Name of the new KeyPair
- @type name: C{str}
+ :param name: Name of the new KeyPair
+ :type name: ``str``
- @rtype: L{OpenStackKeyPair}
+ :rtype: :class:`OpenStackKeyPair`
"""
return self._to_keypair(self.connection.request(
'/os-keypairs', method='POST',
@@ -1714,13 +1714,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Import a KeyPair from a file
- @param name: Name of the new KeyPair
- @type name: C{str}
+ :param name: Name of the new KeyPair
+ :type name: ``str``
- @param keyfile: Path to the public key file (in OpenSSH format)
- @type keyfile: C{str}
+ :param keyfile: Path to the public key file (in OpenSSH format)
+ :type keyfile: ``str``
- @rtype: L{OpenStackKeyPair}
+ :rtype: :class:`OpenStackKeyPair`
"""
with open(os.path.expanduser(keyfile), 'r') as fp:
public_key = fp.read()
@@ -1731,13 +1731,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Import a KeyPair from a string
- @param name: Name of the new KeyPair
- @type name: C{str}
+ :param name: Name of the new KeyPair
+ :type name: ``str``
- @param key_material: Public key (in OpenSSH format)
- @type key_material: C{str}
+ :param key_material: Public key (in OpenSSH format)
+ :type key_material: ``str``
- @rtype: L{OpenStackKeyPair}
+ :rtype: :class:`OpenStackKeyPair`
"""
return self._to_keypair(self.connection.request(
'/os-keypairs', method='POST',
@@ -1748,10 +1748,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Delete a KeyPair.
- @param keypair: KeyPair to delete
- @type keypair: L{OpenStackKeyPair}
+ :param keypair: KeyPair to delete
+ :type keypair: :class:`OpenStackKeyPair`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self.connection.request('/os-keypairs/%s' % (keypair.name),
method='DELETE')
@@ -1761,10 +1761,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a NodeSize
- @param size_id: ID of the size which should be used
- @type size_id: C{str}
+ :param size_id: ID of the size which should be used
+ :type size_id: ``str``
- @rtype: L{NodeSize}
+ :rtype: :class:`NodeSize`
"""
return self._to_size(self.connection.request(
'/flavors/%s' % (size_id,)) .object['flavor'])
@@ -1773,10 +1773,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Get a NodeImage
- @param image_id: ID of the image which should be used
- @type image_id: C{str}
+ :param image_id: ID of the image which should be used
+ :type image_id: ``str``
- @rtype: L{NodeImage}
+ :rtype: :class:`NodeImage`
"""
return self._to_image(self.connection.request(
'/images/%s' % (image_id,)).object['image'])
@@ -1785,10 +1785,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Delete a NodeImage
- @param image: image witch should be used
- @type image: L{NodeImage}
+ :param image: image witch should be used
+ :type image: :class:`NodeImage`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self.connection.request('/images/%s' % (image.id,),
method='DELETE')
@@ -1904,13 +1904,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Rescue a node
- @param node: node
- @type node: L{Node}
+ :param node: node
+ :type node: :class:`Node`
- @param password: password
- @type password: C{str}
+ :param password: password
+ :type password: ``str``
- @rtype: L{Node}
+ :rtype: :class:`Node`
"""
if password:
resp = self._node_action(node, 'rescue', adminPass=password)
@@ -1924,10 +1924,10 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Unrescue a node
- @param node: node
- @type node: L{Node}
+ :param node: node
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self._node_action(node, 'unrescue')
return resp.status == httplib.ACCEPTED
@@ -1943,7 +1943,7 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
List available floating IP pools
- @rtype: C{list} of L{OpenStack_1_1_FloatingIpPool}
+ :rtype: ``list`` of :class:`OpenStack_1_1_FloatingIpPool`
"""
return self._to_floating_ip_pools(
self.connection.request('/os-floating-ip-pools').object)
@@ -1952,13 +1952,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Attach the floating IP to the node
- @param node: node
- @type node: L{Node}
+ :param node: node
+ :type node: :class:`Node`
- @param ip: floating IP to attach
- @type ip: C{str} or L{OpenStack_1_1_FloatingIpAddress}
+ :param ip: floating IP to attach
+ :type ip: ``str`` or :class:`OpenStack_1_1_FloatingIpAddress`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
address = ip.ip_address if hasattr(ip, 'ip_address') else ip
data = {
@@ -1972,13 +1972,13 @@ class OpenStack_1_1_NodeDriver(OpenStackNodeDriver):
"""
Detach the floating IP from the node
- @param node: node
- @type node: L{Node}
+ :param node: node
+ :type node: :class:`Node`
- @param ip: floating IP to remove
- @type ip: C{str} or L{OpenStack_1_1_FloatingIpAddress}
+ :param ip: floating IP to remove
+ :type ip: ``str`` or :class:`OpenStack_1_1_FloatingIpAddress`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
address = ip.ip_address if hasattr(ip, 'ip_address') else ip
data = {
@@ -2002,7 +2002,7 @@ class OpenStack_1_1_FloatingIpPool(object):
"""
List floating IPs in the pool
- @rtype: C{list} of L{OpenStack_1_1_FloatingIpAddress}
+ :rtype: ``list`` of :class:`OpenStack_1_1_FloatingIpAddress`
"""
return self._to_floating_ips(
self.connection.request('/os-floating-ips').object)
@@ -2019,10 +2019,10 @@ class OpenStack_1_1_FloatingIpPool(object):
"""
Get specified floating IP from the pool
- @param ip: floating IP to remove
- @type ip: C{str}
+ :param ip: floating IP to remove
+ :type ip: ``str``
- @rtype: L{OpenStack_1_1_FloatingIpAddress}
+ :rtype: :class:`OpenStack_1_1_FloatingIpAddress`
"""
ip_obj, = [x for x in self.list_floating_ips() if x.ip_address == ip]
return ip_obj
@@ -2031,7 +2031,7 @@ class OpenStack_1_1_FloatingIpPool(object):
"""
Create new floating IP in the pool
- @rtype: L{OpenStack_1_1_FloatingIpAddress}
+ :rtype: :class:`OpenStack_1_1_FloatingIpAddress`
"""
resp = self.connection.request('/os-floating-ips',
method='POST',
@@ -2045,10 +2045,10 @@ class OpenStack_1_1_FloatingIpPool(object):
"""
Delete specified floating IP from the pool
- @param ip: floating IP to remove
- @type ip:L{OpenStack_1_1_FloatingIpAddress}
+ :param ip: floating IP to remove
+ :type ip::class:`OpenStack_1_1_FloatingIpAddress`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
resp = self.connection.request('/os-floating-ips/%s' % ip.id,
method='DELETE')
@@ -2073,7 +2073,7 @@ class OpenStack_1_1_FloatingIpAddress(object):
"""
Delete this floating IP
- @rtype: C{bool}
+ :rtype: ``bool``
"""
return self.pool.delete_floating_ip(self)
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/opsource.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/opsource.py b/libcloud/compute/drivers/opsource.py
index 8b4fa23..ad6bdd2 100644
--- a/libcloud/compute/drivers/opsource.py
+++ b/libcloud/compute/drivers/opsource.py
@@ -247,32 +247,32 @@ class OpsourceNodeDriver(NodeDriver):
"""
Create a new opsource node
- @keyword name: String with a name for this new node (required)
- @type name: C{str}
+ :keyword name: String with a name for this new node (required)
+ :type name: ``str``
- @keyword image: OS Image to boot on node. (required)
- @type image: L{NodeImage}
+ :keyword image: OS Image to boot on node. (required)
+ :type image: :class:`NodeImage`
- @keyword auth: Initial authentication information for the
+ :keyword auth: Initial authentication information for the
node (required)
- @type auth: L{NodeAuthPassword}
+ :type auth: :class:`NodeAuthPassword`
- @keyword ex_description: description for this node (required)
- @type ex_description: C{str}
+ :keyword ex_description: description for this node (required)
+ :type ex_description: ``str``
- @keyword ex_network: Network to create the node within (required)
- @type ex_network: L{OpsourceNetwork}
+ :keyword ex_network: Network to create the node within (required)
+ :type ex_network: :class:`OpsourceNetwork`
- @keyword ex_isStarted: Start server after creation? default
+ :keyword ex_isStarted: Start server after creation? default
true (required)
- @type ex_isStarted: C{bool}
+ :type ex_isStarted: ``bool``
- @return: The newly created L{Node}. NOTE: Opsource does not provide a
+ :return: The newly created :class:`Node`. NOTE: Opsource does not provide a
way to determine the ID of the server that was just created,
- so the returned L{Node} is not guaranteed to be the same one
+ so the returned :class:`Node` is not guaranteed to be the same one
that was created. This is only the case when multiple nodes
with the same name exist.
- @rtype: L{Node}
+ :rtype: :class:`Node`
"""
name = kwargs['name']
image = kwargs['image']
@@ -348,7 +348,7 @@ class OpsourceNodeDriver(NodeDriver):
Currently only returns the default 'base OS images' provided by
opsource. Customer images (snapshots) are not yet supported.
- @inherits: L{NodeDriver.list_images}
+ @inherits: :class:`NodeDriver.list_images`
"""
return self._to_base_images(self.connection.request('base/image')
.object)
@@ -369,7 +369,7 @@ class OpsourceNodeDriver(NodeDriver):
list locations (datacenters) available for instantiating servers and
networks.
- @inherits: L{NodeDriver.list_locations}
+ @inherits: :class:`NodeDriver.list_locations`
"""
return self._to_locations(
self.connection.request_with_orgId('datacenter').object)
@@ -380,11 +380,11 @@ class OpsourceNodeDriver(NodeDriver):
organization. The response includes the location of each network.
- @keyword location: The location
- @type location: L{NodeLocation}
+ :keyword location: The location
+ :type location: :class:`NodeLocation`
- @return: a list of OpsourceNetwork objects
- @rtype: C{list} of L{OpsourceNetwork}
+ :return: a list of OpsourceNetwork objects
+ :rtype: ``list`` of :class:`OpsourceNetwork`
"""
return self._to_networks(
self.connection.request_with_orgId('networkWithLocation').object)
@@ -428,10 +428,10 @@ class OpsourceNodeDriver(NodeDriver):
"""
Powers on an existing deployed server
- @param node: Node which should be used
- @type node: L{Node}
+ :param node: Node which should be used
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
body = self.connection.request_with_orgId(
'server/%s?start' % node.id).object
@@ -445,10 +445,10 @@ class OpsourceNodeDriver(NodeDriver):
A successful response on this function means the system has
successfully passed the request into the operating system.
- @param node: Node which should be used
- @type node: L{Node}
+ :param node: Node which should be used
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
body = self.connection.request_with_orgId(
'server/%s?shutdown' % (node.id)).object
@@ -462,10 +462,10 @@ class OpsourceNodeDriver(NodeDriver):
and application configurations may be adversely affected by the
equivalent of pulling the power plug out of the machine.
- @param node: Node which should be used
- @type node: L{Node}
+ :param node: Node which should be used
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
body = self.connection.request_with_orgId(
'server/%s?poweroff' % node.id).object
@@ -477,8 +477,8 @@ class OpsourceNodeDriver(NodeDriver):
List networks deployed across all data center locations for your
organization. The response includes the location of each network.
- @return: a list of OpsourceNetwork objects
- @rtype: C{list} of L{OpsourceNetwork}
+ :return: a list of OpsourceNetwork objects
+ :rtype: ``list`` of :class:`OpsourceNetwork`
"""
response = self.connection.request_with_orgId('networkWithLocation') \
.object
@@ -488,10 +488,10 @@ class OpsourceNodeDriver(NodeDriver):
"""
Get location by ID.
- @param id: ID of the node location which should be used
- @type id: C{str}
+ :param id: ID of the node location which should be used
+ :type id: ``str``
- @rtype: L{NodeLocation}
+ :rtype: :class:`NodeLocation`
"""
location = None
if id is not None:
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/rackspace.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/rackspace.py b/libcloud/compute/drivers/rackspace.py
index bced602..987a20c 100644
--- a/libcloud/compute/drivers/rackspace.py
+++ b/libcloud/compute/drivers/rackspace.py
@@ -76,10 +76,10 @@ class RackspaceFirstGenNodeDriver(OpenStack_1_0_NodeDriver):
def __init__(self, key, secret=None, secure=True, host=None, port=None,
region='us', **kwargs):
"""
- @inherits: L{NodeDriver.__init__}
+ @inherits: :class:`NodeDriver.__init__`
- @param region: Region ID which should be used
- @type region: C{str}
+ :param region: Region ID which should be used
+ :type region: ``str``
"""
if region not in ['us', 'uk']:
raise ValueError('Invalid region: %s' % (region))
@@ -104,7 +104,7 @@ class RackspaceFirstGenNodeDriver(OpenStack_1_0_NodeDriver):
Locations cannot be set or retrieved via the API, but currently
there are two locations, DFW and ORD.
- @inherits: L{OpenStack_1_0_NodeDriver.list_locations}
+ @inherits: :class:`OpenStack_1_0_NodeDriver.list_locations`
"""
if self.region == 'us':
locations = [NodeLocation(0, "Rackspace DFW1/ORD1", 'US', self)]
@@ -150,10 +150,10 @@ class RackspaceNodeDriver(OpenStack_1_1_NodeDriver):
def __init__(self, key, secret=None, secure=True, host=None, port=None,
region='dfw', **kwargs):
"""
- @inherits: L{NodeDriver.__init__}
+ @inherits: :class:`NodeDriver.__init__`
- @param region: ID of the region which should be used.
- @type region: C{str}
+ :param region: ID of the region which should be used.
+ :type region: ``str``
"""
valid_regions = ENDPOINT_ARGS_MAP.keys()
if region not in valid_regions:
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/rimuhosting.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/rimuhosting.py b/libcloud/compute/drivers/rimuhosting.py
index 6db9b0d..c38556a 100644
--- a/libcloud/compute/drivers/rimuhosting.py
+++ b/libcloud/compute/drivers/rimuhosting.py
@@ -121,22 +121,22 @@ class RimuHostingNodeDriver(NodeDriver):
def __init__(self, key, host=API_HOST, port=443,
api_context=API_CONTEXT, secure=True):
"""
- @param key: API key (required)
- @type key: C{str}
+ :param key: API key (required)
+ :type key: ``str``
- @param host: hostname for connection
- @type host: C{str}
+ :param host: hostname for connection
+ :type host: ``str``
- @param port: Override port used for connections.
- @type port: C{int}
+ :param port: Override port used for connections.
+ :type port: ``int``
- @param api_context: Optional API context.
- @type api_context: C{str}
+ :param api_context: Optional API context.
+ :type api_context: ``str``
- @param secure: Weither to use HTTPS or HTTP.
- @type secure: C{bool}
+ :param secure: Weither to use HTTPS or HTTP.
+ :type secure: ``bool``
- @rtype: C{None}
+ :rtype: ``None``
"""
# Pass in some extra vars so that
self.key = key
@@ -231,41 +231,41 @@ class RimuHostingNodeDriver(NodeDriver):
def create_node(self, **kwargs):
"""Creates a RimuHosting instance
- @inherits: L{NodeDriver.create_node}
+ @inherits: :class:`NodeDriver.create_node`
- @keyword name: Must be a FQDN. e.g example.com.
- @type name: C{str}
+ :keyword name: Must be a FQDN. e.g example.com.
+ :type name: ``str``
- @keyword ex_billing_oid: If not set,
+ :keyword ex_billing_oid: If not set,
a billing method is automatically picked.
- @type ex_billing_oid: C{str}
+ :type ex_billing_oid: ``str``
- @keyword ex_host_server_oid: The host server to set the VPS up on.
- @type ex_host_server_oid: C{str}
+ :keyword ex_host_server_oid: The host server to set the VPS up on.
+ :type ex_host_server_oid: ``str``
- @keyword ex_vps_order_oid_to_clone: Clone another VPS to use as
+ :keyword ex_vps_order_oid_to_clone: Clone another VPS to use as
the image for the new VPS.
- @type ex_vps_order_oid_to_clone: C{str}
+ :type ex_vps_order_oid_to_clone: ``str``
- @keyword ex_num_ips: Number of IPs to allocate. Defaults to 1.
- @type ex_num_ips: C{int}
+ :keyword ex_num_ips: Number of IPs to allocate. Defaults to 1.
+ :type ex_num_ips: ``int``
- @keyword ex_extra_ip_reason: Reason for needing the extra IPs.
- @type ex_extra_ip_reason: C{str}
+ :keyword ex_extra_ip_reason: Reason for needing the extra IPs.
+ :type ex_extra_ip_reason: ``str``
- @keyword ex_memory_mb: Memory to allocate to the VPS.
- @type ex_memory_mb: C{int}
+ :keyword ex_memory_mb: Memory to allocate to the VPS.
+ :type ex_memory_mb: ``int``
- @keyword ex_disk_space_mb: Diskspace to allocate to the VPS.
+ :keyword ex_disk_space_mb: Diskspace to allocate to the VPS.
Defaults to 4096 (4GB).
- @type ex_disk_space_mb: C{int}
+ :type ex_disk_space_mb: ``int``
- @keyword ex_disk_space_2_mb: Secondary disk size allocation.
+ :keyword ex_disk_space_2_mb: Secondary disk size allocation.
Disabled by default.
- @type ex_disk_space_2_mb: C{int}
+ :type ex_disk_space_2_mb: ``int``
- @keyword ex_control_panel: Control panel to install on the VPS.
- @type ex_control_panel: C{str}
+ :keyword ex_control_panel: Control panel to install on the VPS.
+ :type ex_control_panel: ``str``
"""
# Note we don't do much error checking in this because we
# expect the API to error out if there is a problem.
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/slicehost.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/slicehost.py b/libcloud/compute/drivers/slicehost.py
index 08f2144..c8e717c 100644
--- a/libcloud/compute/drivers/slicehost.py
+++ b/libcloud/compute/drivers/slicehost.py
@@ -141,7 +141,7 @@ class SlicehostNodeDriver(NodeDriver):
<error>Permission denied</error>
</errors>
- @inherits: L{NodeDriver.destroy_node}
+ @inherits: :class:`NodeDriver.destroy_node`
"""
uri = '/slices/%s/destroy.xml' % (node.id)
self.connection.request(uri, method='PUT')
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/softlayer.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/softlayer.py b/libcloud/compute/drivers/softlayer.py
index e5611c6..7027fe6 100644
--- a/libcloud/compute/drivers/softlayer.py
+++ b/libcloud/compute/drivers/softlayer.py
@@ -239,24 +239,24 @@ class SoftLayerNodeDriver(NodeDriver):
def create_node(self, **kwargs):
"""Create a new SoftLayer node
- @inherits: L{NodeDriver.create_node}
-
- @keyword ex_domain: e.g. libcloud.org
- @type ex_domain: C{str}
- @keyword ex_cpus: e.g. 2
- @type ex_cpus: C{int}
- @keyword ex_disk: e.g. 100
- @type ex_disk: C{int}
- @keyword ex_ram: e.g. 2048
- @type ex_ram: C{int}
- @keyword ex_bandwidth: e.g. 100
- @type ex_bandwidth: C{int}
- @keyword ex_local_disk: e.g. True
- @type ex_local_disk: C{bool}
- @keyword ex_datacenter: e.g. Dal05
- @type ex_datacenter: C{str}
- @keyword ex_os: e.g. UBUNTU_LATEST
- @type ex_os: C{str}
+ @inherits: :class:`NodeDriver.create_node`
+
+ :keyword ex_domain: e.g. libcloud.org
+ :type ex_domain: ``str``
+ :keyword ex_cpus: e.g. 2
+ :type ex_cpus: ``int``
+ :keyword ex_disk: e.g. 100
+ :type ex_disk: ``int``
+ :keyword ex_ram: e.g. 2048
+ :type ex_ram: ``int``
+ :keyword ex_bandwidth: e.g. 100
+ :type ex_bandwidth: ``int``
+ :keyword ex_local_disk: e.g. True
+ :type ex_local_disk: ``bool``
+ :keyword ex_datacenter: e.g. Dal05
+ :type ex_datacenter: ``str``
+ :keyword ex_os: e.g. UBUNTU_LATEST
+ :type ex_os: ``str``
"""
name = kwargs['name']
os = 'DEBIAN_LATEST'
http://git-wip-us.apache.org/repos/asf/libcloud/blob/f01e0637/libcloud/compute/drivers/vcl.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/vcl.py b/libcloud/compute/drivers/vcl.py
index 0d4e80f..a5ec464 100644
--- a/libcloud/compute/drivers/vcl.py
+++ b/libcloud/compute/drivers/vcl.py
@@ -46,8 +46,8 @@ class VCLNodeDriver(NodeDriver):
"""
VCL node driver
- @keyword host: The VCL host to which you make requests(required)
- @type host: C{str}
+ :keyword host: The VCL host to which you make requests(required)
+ :type host: ``str``
"""
NODE_STATE_MAP = {
@@ -71,22 +71,22 @@ class VCLNodeDriver(NodeDriver):
def __init__(self, key, secret, secure=True, host=None, port=None, *args,
**kwargs):
"""
- @param key: API key or username to used (required)
- @type key: C{str}
+ :param key: API key or username to used (required)
+ :type key: ``str``
- @param secret: Secret password to be used (required)
- @type secret: C{str}
+ :param secret: Secret password to be used (required)
+ :type secret: ``str``
- @param secure: Weither to use HTTPS or HTTP.
- @type secure: C{bool}
+ :param secure: Weither to use HTTPS or HTTP.
+ :type secure: ``bool``
- @param host: Override hostname used for connections. (required)
- @type host: C{str}
+ :param host: Override hostname used for connections. (required)
+ :type host: ``str``
- @param port: Override port used for connections.
- @type port: C{int}
+ :param port: Override port used for connections.
+ :type port: ``int``
- @rtype: C{None}
+ :rtype: ``None``
"""
if not host:
raise Exception('When instantiating VCL driver directly ' +
@@ -109,16 +109,16 @@ class VCLNodeDriver(NodeDriver):
"""Create a new VCL reservation
size and name ignored, image is the id from list_image
- @inherits: L{NodeDriver.create_node}
+ @inherits: :class:`NodeDriver.create_node`
- @keyword image: image is the id from list_image
- @type image: C{str}
+ :keyword image: image is the id from list_image
+ :type image: ``str``
- @keyword start: start time as unix timestamp
- @type start: C{str}
+ :keyword start: start time as unix timestamp
+ :type start: ``str``
- @keyword length: length of time in minutes
- @type length: C{str}
+ :keyword length: length of time in minutes
+ :type length: ``str``
"""
image = kwargs["image"]
@@ -147,10 +147,10 @@ class VCLNodeDriver(NodeDriver):
End VCL reservation for the node passed in.
Throws error if request fails.
- @param node: The node to be destroyed
- @type node: L{Node}
+ :param node: The node to be destroyed
+ :type node: :class:`Node`
- @rtype: C{bool}
+ :rtype: ``bool``
"""
try:
self._vcl_request(
@@ -172,7 +172,7 @@ class VCLNodeDriver(NodeDriver):
"""
List images available to the user provided credentials
- @inherits: L{NodeDriver.list_images}
+ @inherits: :class:`NodeDriver.list_images`
"""
res = self.connection.request(
"XMLRPCgetImages"
@@ -184,7 +184,7 @@ class VCLNodeDriver(NodeDriver):
VCL does not choosing sizes for node creation.
Size of images are statically set by administrators.
- @inherits: L{NodeDriver.list_sizes}
+ @inherits: :class:`NodeDriver.list_sizes`
"""
return [NodeSize(
't1.micro',
@@ -238,10 +238,10 @@ class VCLNodeDriver(NodeDriver):
"""
List nodes
- @param ipaddr: IP address which should be used
- @type ipaddr: C{str}
+ :param ipaddr: IP address which should be used
+ :type ipaddr: ``str``
- @rtype: C{list} of L{Node}
+ :rtype: ``list`` of :class:`Node`
"""
res = self._vcl_request(
"XMLRPCgetRequestIds"
@@ -252,14 +252,14 @@ class VCLNodeDriver(NodeDriver):
"""
Update the remote ip accessing the node.
- @param node: the reservation node to update
- @type node: L{Node}
+ :param node: the reservation node to update
+ :type node: :class:`Node`
- @param ipaddr: the ipaddr used to access the node
- @type ipaddr: C{str}
+ :param ipaddr: the ipaddr used to access the node
+ :type ipaddr: ``str``
- @return: node with updated information
- @rtype: L{Node}
+ :return: node with updated information
+ :rtype: :class:`Node`
"""
return self._to_status(node.id, node.image, ipaddr)
@@ -267,14 +267,14 @@ class VCLNodeDriver(NodeDriver):
"""
Time in minutes to extend the requested node's reservation time
- @param node: the reservation node to update
- @type node: L{Node}
+ :param node: the reservation node to update
+ :type node: :class:`Node`
- @param minutes: the number of mintes to update
- @type minutes: C{str}
+ :param minutes: the number of mintes to update
+ :type minutes: ``str``
- @return: true on success, throws error on failure
- @rtype: C{bool}
+ :return: true on success, throws error on failure
+ :rtype: ``bool``
"""
return self._vcl_request(
"XMLRPCextendRequest",
@@ -286,11 +286,11 @@ class VCLNodeDriver(NodeDriver):
"""
Get the ending time of the node reservation.
- @param node: the reservation node to update
- @type node: L{Node}
+ :param node: the reservation node to update
+ :type node: :class:`Node`
- @return: unix timestamp
- @rtype: C{int}
+ :return: unix timestamp
+ :rtype: ``int``
"""
res = self._vcl_request(
"XMLRPCgetRequestIds"