l.c.d.g.GandiNodeDriver(BaseGandiDriver, NodeDriver) : class documentation

Part of libcloud.compute.drivers.gandi View Source View In Hierarchy

Gandi node driver
Method list_nodes List all nodes @return: list of node objects @rtype: list of Node
Method reboot_node Reboot a node.
Method destroy_node Destroy a node.
Method deploy_node deploy_node is not implemented for gandi driver
Method create_node Create a new Gandi node
Method list_images List images on a provider
Method list_sizes List sizes on a provider
Method list_locations List data centers for a provider
Method list_volumes 0 List all volumes
Method create_volume 0 Undocumented
Method attach_volume 0 Attach a volume to a node
Method detach_volume 0 Detach a volume from a node
Method destroy_volume 0 Undocumented
Method list_volumes 1 List all volumes
Method create_volume 1 Undocumented
Method attach_volume 1 Attach a volume to a node
Method detach_volume 1 Detach a volume from a node
Method destroy_volume 1 Undocumented
Method list_volumes 2 List all volumes
Method create_volume 2 Undocumented
Method attach_volume 2 Attach a volume to a node
Method detach_volume 2 Detach a volume from a node
Method destroy_volume 2 Undocumented
Method list_volumes List all volumes
Method create_volume Create a new volume.
Method attach_volume Attach a volume to a node
Method detach_volume Detach a volume from a node
Method destroy_volume Destroys a storage volume.
Method ex_list_interfaces Specific method to list network interfaces
Method ex_list_disks Specific method to list all disk
Method ex_node_attach_disk Specific method to attach a disk to a node
Method ex_node_detach_disk Specific method to detach a disk from a node
Method ex_node_attach_interface Specific method to attach an interface to a node
Method ex_node_detach_interface Specific method to detach an interface from a node
Method ex_snapshot_disk Specific method to make a snapshot of a disk
Method ex_update_disk Specific method to update size or name of a disk WARNING: if a server is attached it'll be rebooted
Method _resource_info Undocumented
Method _node_info Undocumented
Method _volume_info Undocumented
Method _to_node Undocumented
Method _to_nodes Undocumented
Method _to_volume 0 Undocumented
Method _to_volumes 0 Undocumented
Method _to_volume 1 Undocumented
Method _to_volumes 1 Undocumented
Method _to_volume 2 Undocumented
Method _to_volumes 2 Undocumented
Method _to_volume Undocumented
Method _to_volumes Undocumented
Method _to_image Undocumented
Method _to_size Undocumented
Method _to_loc Undocumented
Method _to_iface Undocumented
Method _to_ifaces Undocumented
Method _to_disk Undocumented
Method _to_disks Undocumented

Inherited from BaseGandiDriver:

Method __init__
Method _wait_operation Wait for an operation to succeed

Inherited from NodeDriver:

Method __init__
Method _wait_until_running Block until node is fully booted and has an IP address assigned.
Method _ssh_client_connect Try to connect to the remote SSH server. If a connection times out or is refused it is retried up to timeout number of seconds.
Method _run_deployment_script Run the deployment script on the provided node. At this point it is assumed that SSH connection has already been established.
Method _get_size_price Undocumented

Inherited from BaseDriver (via NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def _resource_info(self, type, id): (source)
Undocumented
def _node_info(self, id): (source)
Undocumented
def _volume_info(self, id): (source)
Undocumented
def _to_node(self, vm): (source)
Undocumented
def _to_nodes(self, vms): (source)
Undocumented
def _to_volume 0(self, disk): (source)
Undocumented
def _to_volumes 0(self, disks): (source)
Undocumented
def _to_volume 1(self, disk): (source)
Undocumented
def _to_volumes 1(self, disks): (source)
Undocumented
def _to_volume 2(self, disk): (source)
Undocumented
def _to_volumes 2(self, disks): (source)
Undocumented
def _to_volume(self, disk): (source)
Undocumented
def _to_volumes(self, disks): (source)
Undocumented
def list_nodes(self): (source)
List all nodes
Returnslist of node objects (type: list of Node)
def reboot_node(self, node): (source)
Reboot a node.
ParametersnodeThe node to be rebooted (type: Node)
ReturnsTrue if the reboot was successful, otherwise False (type: bool)
def destroy_node(self, node): (source)
Destroy a node.

Depending upon the provider, this may destroy all data associated with the node, including backups.

ParametersnodeThe node to be destroyed (type: Node)
ReturnsTrue if the destroy was successful, otherwise False (type: bool)
def deploy_node(self, **kwargs): (source)
deploy_node is not implemented for gandi driver
Returns (type: bool)
def create_node(self, **kwargs): (source)
Create a new Gandi node
ParametersnameString with a name for this new node (required) (type: str)
imageOS Image to boot on node. (required) (type: NodeImage)
locationWhich data center to create a node in. If empty, undefined behavior will be selected. (optional) (type: NodeLocation)
sizeThe size of resources allocated to this node. (required) (type: NodeSize)
loginuser name to create for login on machine (required) (type: str)
passwordpassword for user that'll be created (required) (type: str)
inet_familyversion of ip to use, default 4 (optional) (type: int)
Returns (type: Node)
def _to_image(self, img): (source)
Undocumented
def list_images(self, location=None): (source)
List images on a provider
ParameterslocationThe location at which to list images (type: NodeLocation)
Returnslist of node image objects (type: list of NodeImage)
def _to_size(self, id, size): (source)
Undocumented
def list_sizes(self, location=None): (source)
List sizes on a provider
ParameterslocationThe location at which to list sizes (type: NodeLocation)
Returnslist of node size objects (type: list of NodeSize)
def _to_loc(self, loc): (source)
Undocumented
def list_locations(self): (source)
List data centers for a provider
Returnslist of node location objects (type: list of NodeLocation)
def list_volumes 0(self): (source)
List all volumes
def create_volume 0(self, size, name, location=None, snapshot=None): (source)
Undocumented
def attach_volume 0(self, node, volume, device=None): (source)
Attach a volume to a node
def detach_volume 0(self, node, volume): (source)
Detach a volume from a node
def destroy_volume 0(self, volume): (source)
Undocumented
def list_volumes 1(self): (source)
List all volumes
def create_volume 1(self, size, name, location=None, snapshot=None): (source)
Undocumented
def attach_volume 1(self, node, volume, device=None): (source)
Attach a volume to a node
def detach_volume 1(self, node, volume): (source)
Detach a volume from a node
def destroy_volume 1(self, volume): (source)
Undocumented
def list_volumes 2(self): (source)
List all volumes
def create_volume 2(self, size, name, location=None, snapshot=None): (source)
Undocumented
def attach_volume 2(self, node, volume, device=None): (source)
Attach a volume to a node
def detach_volume 2(self, node, volume): (source)
Detach a volume from a node
def destroy_volume 2(self, volume): (source)
Undocumented
def list_volumes(self): (source)
List all volumes
def create_volume(self, size, name, location=None, snapshot=None): (source)
Create a new volume.
ParameterssizeSize of volume in gigabytes (required) (type: int)
nameName of the volume to be created (type: str)
locationWhich data center to create a volume in. If empty, undefined behavoir will be selected. (optional) (type: NodeLocation)
snapshotName of snapshot from which to create the new volume. (optional) (type: str)
ReturnsThe newly created volume. (type: StorageVolume)
def attach_volume(self, node, volume, device=None): (source)
Attach a volume to a node
def detach_volume(self, node, volume): (source)
Detach a volume from a node
def destroy_volume(self, volume): (source)
Destroys a storage volume.
ParametersvolumeVolume to be destroyed (type: StorageVolume)
Returns (type: bool)
def _to_iface(self, iface): (source)
Undocumented
def _to_ifaces(self, ifaces): (source)
Undocumented
def ex_list_interfaces(self): (source)
Specific method to list network interfaces
Returns (type: list of GandiNetworkInterface)
def _to_disk(self, element): (source)
Undocumented
def _to_disks(self, elements): (source)
Undocumented
def ex_list_disks(self): (source)
Specific method to list all disk
Returns (type: list of GandiDisk)
def ex_node_attach_disk(self, node, disk): (source)
Specific method to attach a disk to a node
ParametersnodeNode which should be used (type: Node)
diskDisk which should be used (type: GandiDisk)
Returns (type: bool)
def ex_node_detach_disk(self, node, disk): (source)
Specific method to detach a disk from a node
ParametersnodeNode which should be used (type: Node)
diskDisk which should be used (type: GandiDisk)
Returns (type: bool)
def ex_node_attach_interface(self, node, iface): (source)
Specific method to attach an interface to a node
ParametersnodeNode which should be used (type: Node)
ifaceNetwork interface which should be used (type: GandiNetworkInterface)
Returns (type: bool)
def ex_node_detach_interface(self, node, iface): (source)
Specific method to detach an interface from a node
ParametersnodeNode which should be used (type: Node)
ifaceNetwork interface which should be used (type: GandiNetworkInterface)
Returns (type: bool)
def ex_snapshot_disk(self, disk, name=None): (source)
Specific method to make a snapshot of a disk
ParametersdiskDisk which should be used (type: GandiDisk)
nameName which should be used (type: str)
Returns (type: bool)
def ex_update_disk(self, disk, new_size=None, new_name=None): (source)
Specific method to update size or name of a disk WARNING: if a server is attached it'll be rebooted
ParametersdiskDisk which should be used (type: GandiDisk)
new_sizeNew size (type: int)
new_nameNew name (type: str)
Returns (type: bool)
API Documentation for libcloud, generated by pydoctor at 2012-07-28 18:57:18.