This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

The nova.virt.vmwareapi_conn Module

A connection to the VMware ESX platform.

Related Flags

vmwareapi_host_ip:
 IPAddress of VMware ESX server.
vmwareapi_host_username:
 Username for connection to VMware ESX Server.
vmwareapi_host_password:
 Password for connection to VMware ESX Server.
vmwareapi_task_poll_interval:
 The interval (seconds) used for polling of remote tasks (default: 1.0).
vmwareapi_api_retry_count:
 The API retry count in case of failure such as network failures (socket errors etc.) (default: 10).
exception nova.virt.vmwareapi_conn.Failure(details)

Bases: exceptions.Exception

Base Exception class for handling task failures.

class nova.virt.vmwareapi_conn.VMWareAPISession(host_ip, host_username, host_password, api_retry_count, scheme='https')

Bases: object

Sets up a session with the ESX host and handles all the calls made to the host.

class nova.virt.vmwareapi_conn.VMWareESXConnection(host_ip, host_username, host_password, api_retry_count, scheme='https')

Bases: nova.virt.driver.ComputeDriver

The ESX host connection object.

attach_volume(instance_name, device_path, mountpoint)

Attach volume storage to VM instance.

destroy(instance, network_info, cleanup=True)

Destroy VM instance.

detach_volume(instance_name, mountpoint)

Detach volume storage to VM instance.

get_ajax_console(instance)

Return link to instance’s ajax console.

get_console_output(instance)

Return snapshot of console.

get_console_pool_info(console_type)

Get info about the host on which the VM resides.

get_diagnostics(instance)

Return data about VM diagnostics.

get_info(instance_id)

Return info about the VM instance.

host_power_action(host, action)

Reboots, shuts down or powers up the host.

init_host(host)

Do the initialization that needs to be done.

list_instances()

List VM instances.

pause(instance, callback)

Pause VM instance.

plug_vifs(instance, network_info)

Plugs in VIFs to networks.

reboot(instance, network_info)

Reboot VM instance.

resume(instance, callback)

Resume the suspended VM instance.

set_host_enabled(host, enabled)

Sets the specified host’s ability to accept new instances.

snapshot(context, instance, name)

Create snapshot from a running VM instance.

spawn(context, instance, network_info, block_device_mapping=None)

Create VM instance.

suspend(instance, callback)

Suspend the specified instance.

unpause(instance, callback)

Unpause paused VM instance.

update_available_resource(ctxt, host)

This method is supported only by libvirt.

nova.virt.vmwareapi_conn.get_connection(_)

Sets up the ESX host connection.