$ pip install oslo.vmware

$ mkvirtualenv oslo.vmware
$ pip install oslo.vmware

from oslo_vmware import api
from oslo_vmware import vim_util
# Get a handle to a vSphere API session
session = api.VMwareAPISession(


    '10.1.2.3',      # vSphere host endpoint


    'administrator', # vSphere username


    'password',      # vSphere password


    10,              # Number of retries for connection failures in tasks


    0.1              # Poll interval for async tasks (in seconds)
)
# Example call to get all the managed objects of type "HostSystem"
# on the server.
result = session.invoke_api(


    vim_util,                           # Handle to VIM utility module


    'get_objects',                      # API method name to invoke


    session.vim, 'HostSystem', 100)     # Params to API method (*args)

start(initial_delay=None, periodic_interval_max=None)

start(interval, initial_delay=None)

stop()

wait()

•

This check assumes that 'LOG' is a logger.

Parameters

Returns

None if the logical line passes the check, otherwise a tuple is yielded that contains the offending index in logical line and a message describe the check validation failure.

build_path(*paths)

Constructs and returns a DatastorePath.

build_url(scheme, server, rel_path, datacenter_name=None)

Constructs and returns a DatastoreURL.

static choose_host(hosts)

get_connected_hosts(session)

Get a list of usable (accessible, mounted, read-writable) hosts where the datastore is mounted.

get_summary(session)

Get datastore summary.

static is_datastore_mount_usable(mount_info)

Check if a datastore is usable as per the given mount info.

The datastore is considered to be usable for a host only if it is writable, mounted and accessible.

• Datastore path representations always uses forward slash as separator (hence the use of the posixpath module).
• Datastore names are enclosed in square brackets.
• Path part of datastore path is relative to the root directory of the datastore, and is always separated from the [ds_name] part with a single space.

property basename

property datastore

property dirname

join(*paths)

Join one or more path components intelligently into a datastore path.

If any component is an absolute path, all previous components are thrown away, and joining continues. The return value is the concatenation of the paths with exactly one slash ('/') inserted between components, unless p is empty.

property parent

classmethod parse(datastore_path)

Constructs a DatastorePath object given a datastore path string.

property rel_path

connect(method, content_length, cookie)

property datacenter_path

property datastore_name

get_transfer_ticket(session, method)

property path

classmethod urlparse(url)

Parameters

Return type

a datastore object

Parameters

ds_val -- datastore cluster name or datastore cluster moid

Returns

tuple of dastastore cluster moref and datastore cluster name

Parameters

Example:

invoke_api(module, method, *args, **kwargs)

Wrapper method for invoking APIs.

The API call is retried in the event of exceptions due to session overload or connection problems.

is_current_session_active()

Check if current session is active.

logout()

Log out and terminate the current session.

property pbm

pbm_wsdl_loc_set(pbm_wsdl_loc)

property vim

wait_for_lease_ready(lease)

Waits for the given lease to be ready.

This method return when the lease is ready. In case of any error, appropriate exception is raised.

wait_for_task(task)

Waits for the given task to complete and returns the result.

The task is polled until it is done. The method returns the task information upon successful completion. In case of any error, appropriate exception is raised.

Parameters

Returns

The new portgroup moref

Parameters

Parameters

value -- value of the DVS managed object

Returns

managed object reference with given value and type 'VmwareDistributedVirtualSwitch'

Parameters

Returns

The configuration for a port group.

Parameters

Returns

List of tuples that have the following format: (portgroup name, port group moref)

Parameters

Returns

The configuration when a port uses trunk mode. This allows a guest to manage the vlan id.

Parameters

Returns

The configuration when a single vlan_id is used for a port

code = 409

msg_fmt = 'Resource already exists.'

code = 403

msg_fmt = 'Cannot delete file.'

msg_fmt = 'Duplicate name.'

code = 409

msg_fmt = 'File already exists.'

code = 409

msg_fmt = 'File fault.'

code = 403

msg_fmt = 'File locked.'

code = 404

msg_fmt = 'File not found.'

code = 409

msg_fmt = 'Invalid power state.'

code = 400

msg_fmt = 'Invalid property.'

code = 404

msg_fmt = 'Managed object not found.'

msg_fmt = 'Missing parameter : %(param)s'

msg_fmt = 'Insufficient disk space.'

code = 403

msg_fmt = 'No Permission.'

code = 403

msg_fmt = 'Not Authenticated.'

msg_fmt = 'Entity has another operation in process.'

msg_fmt = 'VMware Tools is not running.'

msg_fmt = 'No default value for use_linked_clone found.'

msg_fmt = 'VMware Driver configuration fault.'

property description

property msg

msg_fmt = 'An unknown exception occurred.'

property description

Parameters

excep_msg -- Message to set to the exception. Defaults to localizedMessage of the fault.

Parameters

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError

Parameters

Parameters

Raises

VimConnectionException, ImageTransferException, ValueError

Parameters

Parameters

Returns

managed object reference of the VM created for import to VMware server

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError

Parameters

Returns

managed object reference of the VM created for import to VMware server

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError

Parameters

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError

retrieve_service_content()

set_soap_cookie(cookie)

Set the specified vCenter session cookie in the SOAP header

Parameters

Returns

list of PbmPlacementHub morefs

Parameters

Returns

subset of datastores corresponding to the given hub list

Parameters

Returns

subset of hubs that match the given profile

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Returns

PbmProfile data objects

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

vc_version -- a dot-separated version string. For example, "1.2".

Returns

the pbm wsdl file location.

Parameters

profile_name -- profile name whose UUID needs to be retrieved

Returns

profile UUID string or None if profile not found

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

Returns

profile IDs

Parameters

Returns

profile objects

close()

Close the file handle.

fileno()

returns the integer file descriptor by default this is not supported and raises IOError

flush()

flushes the internal buffer

get_size()

Get size of the file to be read.

read(chunk_size)

Read a chunk of data.

seek(offset)

sets the file's current position at the offset

tell()

Get the position of File Handle

write(data)

Write data to the file.

close()

Closes the connection.

get_size()

Get size of the file to be read.

read(length)

Read data from the file. :param length: amount of data to be read :raises: VimConnectionException, VimException

close()

Get the response and close the connection.

write(data)

Write data to the file.

close()

Close the read handle.

This is a NOP.

get_next()

Get the next item from the image iterator.

read(chunk_size)

Read an item from the image data iterator.

The input chunk size is ignored since the client ImageBodyIterator uses its own chunk size.

update_progress()

Updates progress to lease.

This call back to the lease is essential to keep the lease alive across long running write/read operations.

close()

Releases the lease and close the connection.

read(chunk_size=65536)

Read a chunk of data from the VMDK file.

tell()

Get the position of File Handle

close()

Releases the lease and close the connection.

get_imported_vm()

"Get managed object reference of the VM created for import.

tell()

Get the position of File Handle

write(data)

Write data to the file.

property cookiejar

send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)

Sends request for a local file.

get(key)

Retrieves the value for a key or None.

put(key, value, time=3600)

Sets the value for a key.

open(request)

Open the url in the specified request. @param request: A transport request. @type request: L{Request} @return: An input stream. @rtype: stream @raise TransportError: On all transport errors.

send(request)

@param request: A transport request. @type request: L{Request} @return: The reply @rtype: L{Reply} @raise TransportError: On all transport errors.

get_all(name, default)

getheaders(name)

info()

property msg

read(chunk_size, **kwargs)

Read at most size bytes, returned as a bytes object.

If the size argument is negative, read until EOF is reached. Return an empty bytes object at EOF.

release_conn()

static build_base_url(protocol, host, port)

get_http_cookie()

Return the vCenter session cookie.

property service_content

EMPTY_ELEMENTS = ['VirtualMachineEmptyProfileSpec']

add_attribute_for_value(node)

Helper to handle AnyType.

Suds does not handle AnyType properly. But VI SDK requires type attribute to be set when AnyType is used.

marshalled(context)

Modifies the envelope document before it is sent.

This method provides the plug-in with the opportunity to prune empty nodes and fix nodes before sending it to the server.

prune(el)

filter(record)

Determine if the specified record is to be logged.

Returns True if the record should be logged, or False otherwise. If deemed appropriate, the record may be modified in-place.

retrieve_service_content()

Parameters

Returns

object spec

Parameters

Returns

property filter spec

Parameters

Returns

property spec

Parameters

client_factory -- factory to get API input specs

Returns

recursive traversal spec

Parameters

Returns

selection spec

Parameters

Returns

traversal spec

Parameters

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

Returns

the data object Extension or None

Parameters

Parameters

Returns

inventory path of the entity_ref

Parameters

Returns

managed object reference with given value and type

Parameters

Returns

properties of the given managed object

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

Returns

a dict of properties of the given managed object

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

Returns

property of the given managed object

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

Returns

all managed object references of the given type

Raises

VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException

Parameters

session -- vCenter soap session

Returns

vCenter version

Parameters

propset -- a property "set" from ObjectContent

Returns

dictionary representing property set

Parameters