libcloud.compute.drivers.vcloud.VCloud_1_5_NodeDriver : API documentation

def list_locations(self): (source)

overrides libcloud.compute.base.NodeDriver.list_locations

List data centers for a provider

Returns list of NodeLocation objects

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.

Parameters	node_name	The name of the node to search for (type: `Vdc`)
	vdcs	None, vDC or a list of vDCs to search in. If None all vDCs will be searched.
Returns	`Node` node instance or None if not found

def destroy_node(self, node): (source)

overrides libcloud.compute.drivers.vcloud.VCloudNodeDriver.destroy_node

Destroy a node.

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

Parameters	node	The node to be destroyed (type: `Node`)
Returns	`bool` True if the destroy was successful, otherwise False

def reboot_node(self, node): (source)

overrides libcloud.compute.drivers.vcloud.VCloudNodeDriver.reboot_node

Reboot a node.

Parameters	node	The node to be rebooted (type: `Node`)
Returns	`bool` True if the reboot was successful, otherwise False

def ex_deploy_node(self, node): (source)

Deploys existing node. Equal to vApp "start" operation.

Parameters	node	The node to be deployed (type: `Node`)
Returns	`Node` deployed node

def ex_undeploy_node(self, node): (source)

Undeploys existing node. Equal to vApp "stop" operation.

Parameters	node	The node to be deployed (type: `Node`)
Returns	`Node` undeployed node instance

def create_node(self, **kwargs): (source)

overrides libcloud.compute.drivers.vcloud.VCloudNodeDriver.create_node

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.

See NodeDriver.create_node for more keyword args.

Parameters	image	OS Image to boot on node. (required). Can be a NodeImage or existing Node that will be cloned. (type: `NodeImage` or `Node` Non-standard optional keyword arguments: )
	ex_network	Organisation's network name for attaching vApp VMs to. (type: `string`)
	ex_vdc	Name of organisation's virtual data center where vApp VMs will be deployed. (type: `string`)
	ex_vm_names	list 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 `string`)
	ex_vm_cpu	number of virtual CPUs/cores to allocate for each vApp VM. (type: `number`)
	ex_vm_memory	amount of memory in MB to allocate for each vApp VM. (type: `number`)
	ex_vm_script	full path to file containing guest customisation script for each vApp VM. Useful for creating users & pushing out public SSH keys etc. (type: `string`)
	ex_vm_network	Override default vApp VM network name. Useful for when you've imported an OVF originating from outside of the vCloud. (type: `string`)
	ex_vm_fence	Fence mode for connecting the vApp VM network (ex_vm_network) to the parent organisation network (ex_network). (type: `string`)
	ex_vm_ipmode	IP address allocation mode for all vApp VM network connections. (type: `string`)
	ex_deploy	set to False if the node shouldn't be deployed (started) after creation (type: `bool`)

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.

Parameters	vapp_or_vm_id	vApp or VM ID that will be modified. If a vApp ID is used here all attached VMs will be modified (type: `string`)
	vm_cpu	number of virtual CPUs/cores to allocate for specified VMs (type: `number`)

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.

Parameters	vapp_or_vm_id	vApp or VM ID that will be modified. If a vApp ID is used here all attached VMs will be modified (type: `string`)
	vm_memory	virtual memory in MB to allocate for the specified VM or VMs (type: `number`)

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.

Parameters	vapp_or_vm_id	vApp or VM ID that will be modified. If a vApp ID is used here all attached VMs will be modified (type: `string`)
	vm_disk_size	the disk capacity in GB that will be added to the specified VM or VMs (type: `number`)

@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)

overrides libcloud.compute.drivers.vcloud.VCloudNodeDriver._to_node

Undocumented

Method	__new__	Undocumented
Method	vdcs	vCloud virtual data centers (vDCs). @return: `list` of `Vdc` objects
Method	networks	Undocumented
Method	list_nodes	List all nodes @return: `list` of `Node` objects
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

Method	__init__
Method	deploy_node	Create a new node, and start deployment.
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

Method	list_locations	List data centers for a provider @return: `list` of `NodeLocation` objects
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

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