The oslo_vmware.objects.datastore Module

class oslo_vmware.objects.datastore.Datastore(ref, name, capacity=None, freespace=None, type=None, datacenter=None)

Bases: object

build_path(*paths)

Constructs and returns a DatastorePath.

Parameters:paths – list of path components, for constructing a path relative to the root directory of the datastore
Returns:a DatastorePath object
build_url(scheme, server, rel_path, datacenter_name=None)

Constructs and returns a DatastoreURL.

Parameters:
  • scheme – scheme of the URL (http, https).
  • server – hostname or ip
  • rel_path – relative path of the file on the datastore
  • datacenter_name – (optional) datacenter name
Returns:

a DatastoreURL object
static choose_host(hosts)
get_connected_hosts(session)

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

Param:session: session
Returns:list of HostSystem managed object references
get_summary(session)

Get datastore summary.

Parameters:datastore – Reference to the datastore
Returns:‘summary’ property of the datastore
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.

Parameters:mount_info – HostMountInfo data object
Returns:True if datastore is usable
class oslo_vmware.objects.datastore.DatastorePath(datastore_name, *paths)

Bases: object

Class for representing a directory or file path in a vSphere datatore.

This provides various helper methods to access components and useful variants of the datastore path.

Example usage:

DatastorePath(“datastore1”, “_base/foo”, “foo.vmdk”) creates an object that describes the “[datastore1] _base/foo/foo.vmdk” datastore file path to a virtual disk.

Note: - 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.
basename
datastore
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.

Returns:A datastore path
parent
classmethod parse(datastore_path)

Constructs a DatastorePath object given a datastore path string.

rel_path
class oslo_vmware.objects.datastore.DatastoreURL(scheme, server, path, datacenter_path, datastore_name)

Bases: object

Class for representing a URL to HTTP access a file in a datastore.

This provides various helper methods to access components and useful variants of the datastore URL.

connect(method, content_length, cookie)
datacenter_path
datastore_name
get_transfer_ticket(session, method)
path
classmethod urlparse(url)
oslo_vmware.objects.datastore.get_datastore_by_ref(session, ds_ref)

Returns a datastore object for a given reference.

Parameters:
  • session – a vmware api session object
  • ds_ref – managed object reference of a datastore

:rtype : a datastore object