l.c.d.v.VCloud_1_5_NodeDriver(VCloudNodeDriver) : class documentation

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

No class docstring
Method list_locations List data centers for a provider
Method ex_find_node Searches for node across specified vDCs. This is more effective than querying all nodes to get a single instance.
Method destroy_node Destroy a node.
Method reboot_node Reboot a node.
Method ex_deploy_node Deploys existing node. Equal to vApp "start" operation.
Method ex_undeploy_node Undeploys existing node. Equal to vApp "stop" operation.
Method create_node No summary
Method ex_set_vm_cpu Sets the number of virtual CPUs for the specified VM or VMs under the vApp. If the vapp_or_vm_id param represents a link to an vApp all VMs that are attached to this vApp will be modified.
Method ex_set_vm_memory Sets the virtual memory in MB to allocate for the specified VM or VMs under the vApp. If the vapp_or_vm_id param represents a link to an vApp all VMs that are attached to this vApp will be modified.
Method ex_add_vm_disk Adds a virtual disk to the specified VM or VMs under the vApp. If the vapp_or_vm_id param represents a link to an vApp all VMs that are attached to this vApp will be modified.
Method _instantiate_node Undocumented
Method _clone_node Undocumented
Static Method _validate_vm_names Undocumented
Static Method _validate_vm_memory Undocumented
Static Method _validate_vm_cpu Undocumented
Static Method _validate_vm_disk_size Undocumented
Static Method _validate_vm_script Undocumented
Static Method _validate_vm_fence Undocumented
Static Method _validate_vm_ipmode Undocumented
Method _change_vm_names Undocumented
Method _change_vm_cpu Undocumented
Method _change_vm_memory Undocumented
Method _add_vm_disk Undocumented
Method _change_vm_script Undocumented
Method _change_vm_ipmode Undocumented
Method _get_network_href Undocumented
Method _get_vm_elements Undocumented
Method _is_node Undocumented
Method _to_node Undocumented

Inherited from VCloudNodeDriver:

Method __new__ Undocumented
Method vdcs vCloud virtual data centers (vDCs).
Method networks Undocumented
Method list_nodes List all nodes @return: list of node objects @rtype: list of Node
Method list_sizes List sizes on a provider
Method list_images List images on a provider
Method _get_vdc Undocumented
Method _to_image Undocumented
Method _get_catalog_hrefs Undocumented
Method _wait_for_task_completion Undocumented
Method _to_size Undocumented
Method _get_catalogitems_hrefs Given a catalog href returns contained catalog item hrefs
Method _get_catalogitem Given a catalog item href returns elementree
Method _uniquer Undocumented

Inherited from NodeDriver (via VCloudNodeDriver):

Method __init__
Method deploy_node Create a new node, and start deployment.
Method create_volume Create a new volume.
Method destroy_volume Destroys a storage volume.
Method attach_volume Attaches volume to node.
Method detach_volume Detaches a volume from a node.
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 VCloudNodeDriver, NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def list_locations(self): (source)
List data centers for a provider
Returnslist of node location objects (type: list of NodeLocation)
def ex_find_node(self, node_name, vdcs=None): (source)
Searches for node across specified vDCs. This is more effective than querying all nodes to get a single instance.
Parametersnode_nameThe name of the node to search for (type: VCloudVDC)
vdcsNone, vDC or a list of vDCs to search in. If None all vDCs will be searched.
Returnsnode instance or None if not found (type: Node or None)
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 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 ex_deploy_node(self, node): (source)
Deploys existing node. Equal to vApp "start" operation.
ParametersnodeThe node to be deployed (type: Node)
Returns (type: Node)
def ex_undeploy_node(self, node): (source)
Undeploys existing node. Equal to vApp "stop" operation.
ParametersnodeThe node to be deployed (type: Node)
Returns (type: Node)
def create_node(self, **kwargs): (source)

Creates and returns node. If the source image is:

  • vApp template - a new vApp is instantiated from template
  • existing vApp - a new vApp is cloned from the source vApp. Can not clone more vApps is parallel otherwise resource busy error is raised.
ParametersimageOS Image to boot on node. (required). Can be a NodeImage or existing Node that will be cloned. (type: NodeImage or Node)
ex_networkOrganisation's network name for attaching vApp VMs to. (type: str)
ex_vdcName of organisation's virtual data center where vApp VMs will be deployed. (type: str)
ex_vm_nameslist of names to be used as a VM and computer name. The name must be max. 15 characters long and follow the host name requirements. (type: list of str)
ex_vm_cpunumber of virtual CPUs/cores to allocate for each vApp VM. (type: int)
ex_vm_memoryamount of memory in MB to allocate for each vApp VM. (type: int)
ex_vm_scriptfull path to file containing guest customisation script for each vApp VM. Useful for creating users & pushing out public SSH keys etc. (type: str)
ex_vm_networkOverride default vApp VM network name. Useful for when you've imported an OVF originating from outside of the vCloud. (type: str)
ex_vm_fenceFence mode for connecting the vApp VM network (ex_vm_network) to the parent organisation network (ex_network). (type: str)
ex_vm_ipmodeIP address allocation mode for all vApp VM network connections. (type: str)
ex_deployset to False if the node shouldn't be deployed (started) after creation (type: bool)
Unknown Field: inheritsNodeDriver.create_node
def _instantiate_node(self, name, image, network_elem, vdc, vm_network, vm_fence): (source)
Undocumented
def _clone_node(self, name, sourceNode, vdc): (source)
Undocumented
def ex_set_vm_cpu(self, vapp_or_vm_id, vm_cpu): (source)
Sets the number of virtual CPUs for the specified VM or VMs under the vApp. If the vapp_or_vm_id param represents a link to an vApp all VMs that are attached to this vApp will be modified.

Please ensure that hot-adding a virtual CPU is enabled for the powered on virtual machines. Otherwise use this method on undeployed vApp.

Parametersvapp_or_vm_idvApp or VM ID that will be modified. If a vApp ID is used here all attached VMs will be modified (type: str)
vm_cpunumber of virtual CPUs/cores to allocate for specified VMs (type: int)
Returns (type: None)
def ex_set_vm_memory(self, vapp_or_vm_id, vm_memory): (source)
Sets the virtual memory in MB to allocate for the specified VM or VMs under the vApp. If the vapp_or_vm_id param represents a link to an vApp all VMs that are attached to this vApp will be modified.

Please ensure that hot-change of virtual memory is enabled for the powered on virtual machines. Otherwise use this method on undeployed vApp.

Parametersvapp_or_vm_idvApp or VM ID that will be modified. If a vApp ID is used here all attached VMs will be modified (type: str)
vm_memoryvirtual memory in MB to allocate for the specified VM or VMs (type: int)
Returns (type: None)
def ex_add_vm_disk(self, vapp_or_vm_id, vm_disk_size): (source)
Adds a virtual disk to the specified VM or VMs under the vApp. If the vapp_or_vm_id param represents a link to an vApp all VMs that are attached to this vApp will be modified.
Parametersvapp_or_vm_idvApp or VM ID that will be modified. If a vApp ID is used here all attached VMs will be modified (type: str)
vm_disk_sizethe disk capacity in GB that will be added to the specified VM or VMs (type: int)
Returns (type: None)
@staticmethod
def _validate_vm_names(names): (source)
Undocumented
@staticmethod
def _validate_vm_memory(vm_memory): (source)
Undocumented
@staticmethod
def _validate_vm_cpu(vm_cpu): (source)
Undocumented
@staticmethod
def _validate_vm_disk_size(vm_disk): (source)
Undocumented
@staticmethod
def _validate_vm_script(vm_script): (source)
Undocumented
@staticmethod
def _validate_vm_fence(vm_fence): (source)
Undocumented
@staticmethod
def _validate_vm_ipmode(vm_ipmode): (source)
Undocumented
def _change_vm_names(self, vapp_or_vm_id, vm_names): (source)
Undocumented
def _change_vm_cpu(self, vapp_or_vm_id, vm_cpu): (source)
Undocumented
def _change_vm_memory(self, vapp_or_vm_id, vm_memory): (source)
Undocumented
def _add_vm_disk(self, vapp_or_vm_id, vm_disk): (source)
Undocumented
def _change_vm_script(self, vapp_or_vm_id, vm_script): (source)
Undocumented
def _change_vm_ipmode(self, vapp_or_vm_id, vm_ipmode): (source)
Undocumented
def _get_network_href(self, network_name): (source)
Undocumented
def _get_vm_elements(self, vapp_or_vm_id): (source)
Undocumented
def _is_node(self, node_or_image): (source)
Undocumented
def _to_node(self, node_elm): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2012-07-28 18:57:18.