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

List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}

Searches for node across specified vDCs. This is more effective than querying all nodes to get a single
instance.

@param node_name: The name of the node to search for
@type node_name: C{str}

@param vdcs: None, vDC or a list of vDCs to search in. If None all vDCs will be searched.
@type node_name: L{VCloudVDC}

@return: node instance or None if not found
@rtype: L{Node} or C{None}

Destroy a node.

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

@param node: The node to be destroyed
@type node: L{Node}

@return: True if the destroy was successful, otherwise False
@rtype: C{bool}

Reboot a node.

@param node: The node to be rebooted
@type node: L{Node}

@return: True if the reboot was successful, otherwise False
@rtype: C{bool}

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

@param  node: The node to be deployed
@type   node: L{Node}

@rtype: L{Node}

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

@param  node: The node to be deployed
@type   node: L{Node}

@rtype: L{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.


@inherits: L{NodeDriver.create_node}

@keyword    image:  OS Image to boot on node. (required). Can be a NodeImage or existing Node that will be
                    cloned.
@type       image:  L{NodeImage} or L{Node}

@keyword    ex_network: Organisation's network name for attaching vApp VMs to.
@type       ex_network: C{str}

@keyword    ex_vdc: Name of organisation's virtual data center where vApp VMs will be deployed.
@type       ex_vdc: C{str}

@keyword    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       ex_vm_names: C{list} of C{str}

@keyword    ex_vm_cpu: number of virtual CPUs/cores to allocate for each vApp VM.
@type       ex_vm_cpu: C{int}

@keyword    ex_vm_memory: amount of memory in MB to allocate for each vApp VM.
@type       ex_vm_memory: C{int}

@keyword    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       ex_vm_script: C{str}

@keyword    ex_vm_network: Override default vApp VM network name. Useful for when you've imported an OVF
                           originating from outside of the vCloud.
@type       ex_vm_network: C{str}

@keyword    ex_vm_fence: Fence mode for connecting the vApp VM network (ex_vm_network) to the parent
                         organisation network (ex_network).
@type       ex_vm_fence: C{str}

@keyword    ex_vm_ipmode: IP address allocation mode for all vApp VM network connections.
@type       ex_vm_ipmode: C{str}

@keyword    ex_deploy: set to False if the node shouldn't be deployed (started) after creation
@type       ex_deploy: C{bool}

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.

@keyword    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       vapp_or_vm_id: C{str}

@keyword    vm_cpu: number of virtual CPUs/cores to allocate for specified VMs
@type       vm_cpu: C{int}

@rtype: C{None}

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.

@keyword    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       vapp_or_vm_id: C{str}

@keyword    vm_memory: virtual memory in MB to allocate for the specified VM or VMs
@type       vm_memory: C{int}

@rtype: C{None}

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.

@keyword    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       vapp_or_vm_id: C{str}

@keyword    vm_disk_size: the disk capacity in GB that will be added to the specified VM or VMs
@type       vm_disk_size: C{int}

@rtype: C{None}