Session and API call management for VMware ESX/VC server.
This module contains classes to invoke VIM APIs. It supports automatic session re-establishment and retry of API invocations in case of connection problems or server API call overload.
oslo_vmware.api.
RetryDecorator
(max_retry_count=-1, inc_sleep_time=10, max_sleep_time=60, exceptions=())¶Bases: object
Decorator for retrying a function upon suggested exceptions.
The decorated function is retried for the given number of times, and the sleep time between the retries is incremented until max sleep time is reached. If the max retry count is set to -1, then the decorated function is invoked indefinitely until an exception is thrown, and the caught exception is not in the list of suggested exceptions.
oslo_vmware.api.
VMwareAPISession
(host, server_username, server_password, api_retry_count, task_poll_interval, scheme='https', create_session=True, wsdl_loc=None, pbm_wsdl_loc=None, port=443, cacert=None, insecure=True, pool_size=10, connection_timeout=None, op_id_prefix='oslo.vmware')¶Bases: object
Setup a session with the server and handles all calls made to it.
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.
Parameters: |
|
---|---|
Returns: | response from the API call |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
is_current_session_active
()¶Check if current session is active.
Returns: | True if the session is active; False otherwise |
---|
logout
()¶Log out and terminate the current session.
pbm
¶pbm_wsdl_loc_set
(pbm_wsdl_loc)¶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.
Parameters: | lease – lease to be checked for |
---|---|
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
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: | task – managed object reference of the task |
---|---|
Returns: | task info upon successful completion of the task |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
Shared constants across the VMware ecosystem.
oslo_vmware.dvs_util.
add_port_group
(session, dvs_moref, name, vlan_id=None, trunk_mode=False)¶Add a new port group to the dvs_moref
Parameters: |
|
---|---|
Returns: | The new portgroup moref |
oslo_vmware.dvs_util.
delete_port_group
(session, portgroup_moref)¶Delete a specific port group
Parameters: |
|
---|
oslo_vmware.dvs_util.
get_dvs_moref
(value)¶Get managed DVS object reference.
Parameters: | value – value of the DVS managed object |
---|---|
Returns: | managed object reference with given value and type ‘VmwareDistributedVirtualSwitch’ |
oslo_vmware.dvs_util.
get_port_group_spec
(session, name, vlan_id, trunk_mode=False)¶Gets the port group spec for a distributed port group
Parameters: |
|
---|---|
Returns: | The configuration for a port group. |
oslo_vmware.dvs_util.
get_portgroups
(session, dvs_moref)¶Gets all configured portgroups on the dvs_moref
Parameters: |
|
---|---|
Returns: | List of tuples that have the following format: (portgroup name, port group moref) |
oslo_vmware.dvs_util.
get_trunk_vlan_spec
(session, start=0, end=4094)¶Gets portgroup trunk vlan spec.
Parameters: |
|
---|---|
Returns: | The configuration when a port uses trunk mode. This allows a guest to manage the vlan id. |
oslo_vmware.dvs_util.
get_vlan_spec
(session, vlan_id)¶Gets portgroup vlan spec.
Parameters: |
|
---|---|
Returns: | The configuration when a single vlan_id is used for a port |
Exception definitions.
oslo_vmware.exceptions.
AlreadyExistsException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 409¶msg_fmt
= 'Resource already exists.'¶oslo_vmware.exceptions.
CannotDeleteFileException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 403¶msg_fmt
= 'Cannot delete file.'¶oslo_vmware.exceptions.
DuplicateName
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
msg_fmt
= 'Duplicate name.'¶oslo_vmware.exceptions.
FileAlreadyExistsException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 409¶msg_fmt
= 'File already exists.'¶oslo_vmware.exceptions.
FileFaultException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 409¶msg_fmt
= 'File fault.'¶oslo_vmware.exceptions.
FileLockedException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 403¶msg_fmt
= 'File locked.'¶oslo_vmware.exceptions.
FileNotFoundException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 404¶msg_fmt
= 'File not found.'¶oslo_vmware.exceptions.
ImageTransferException
(message, cause=None)¶Bases: oslo_vmware.exceptions.VMwareDriverException
Thrown when there is an error during image transfer.
oslo_vmware.exceptions.
InvalidPowerStateException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 409¶msg_fmt
= 'Invalid power state.'¶oslo_vmware.exceptions.
InvalidPropertyException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 400¶msg_fmt
= 'Invalid property.'¶oslo_vmware.exceptions.
ManagedObjectNotFoundException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 404¶msg_fmt
= 'Managed object not found.'¶oslo_vmware.exceptions.
MissingParameter
(message=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VMwareDriverException
msg_fmt
= 'Missing parameter : %(param)s'¶oslo_vmware.exceptions.
NoDiskSpaceException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
msg_fmt
= 'Insufficient disk space.'¶oslo_vmware.exceptions.
NoPermissionException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 403¶msg_fmt
= 'No Permission.'¶oslo_vmware.exceptions.
NotAuthenticatedException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
code
= 403¶msg_fmt
= 'Not Authenticated.'¶oslo_vmware.exceptions.
TaskInProgress
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VimException
msg_fmt
= 'Entity has another operation in process.'¶oslo_vmware.exceptions.
UseLinkedCloneConfigurationFault
(message=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VMwareDriverConfigurationException
msg_fmt
= 'No default value for use_linked_clone found.'¶oslo_vmware.exceptions.
VMwareDriverConfigurationException
(message=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VMwareDriverException
Base class for all configuration exceptions.
msg_fmt
= 'VMware Driver configuration fault.'¶oslo_vmware.exceptions.
VMwareDriverException
(message=None, details=None, **kwargs)¶Bases: Exception
Base oslo.vmware exception
To correctly use this class, inherit from it and define a ‘msg_fmt’ property. That msg_fmt will get printf’d with the keyword arguments provided to the constructor.
description
¶msg
¶msg_fmt
= 'An unknown exception occurred.'¶oslo_vmware.exceptions.
VimAttributeException
(message, cause=None)¶Bases: oslo_vmware.exceptions.VMwareDriverException
Thrown when a particular attribute cannot be found.
oslo_vmware.exceptions.
VimConnectionException
(message, cause=None)¶Bases: oslo_vmware.exceptions.VMwareDriverException
Thrown when there is a connection problem.
oslo_vmware.exceptions.
VimException
(message=None, cause=None, details=None, **kwargs)¶Bases: oslo_vmware.exceptions.VMwareDriverException
The base exception class for all VIM related exceptions.
oslo_vmware.exceptions.
VimFaultException
(fault_list, message, cause=None, details=None)¶Bases: oslo_vmware.exceptions.VimException
Exception thrown when there are unrecognized VIM faults.
description
¶oslo_vmware.exceptions.
VimSessionOverLoadException
(message, cause=None)¶Bases: oslo_vmware.exceptions.VMwareDriverException
Thrown when there is an API call overload at the VMware server.
oslo_vmware.exceptions.
get_fault_class
(name)¶Get a named subclass of VimException.
oslo_vmware.exceptions.
register_fault_class
(name, exception)¶Functions and classes for image transfer between ESX/VC & image service.
oslo_vmware.image_transfer.
copy_stream_optimized_disk
(context, timeout_secs, write_handle, **kwargs)¶Copy virtual disk from VMware server to the given write handle.
Parameters: |
|
---|---|
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError |
oslo_vmware.image_transfer.
download_file
(read_handle, host, port, dc_name, ds_name, cookies, upload_file_path, file_size, cacerts, timeout_secs)¶Download file to VMware server.
Parameters: |
|
---|
oslo_vmware.image_transfer.
download_flat_image
(context, timeout_secs, image_service, image_id, **kwargs)¶Download flat image from the image service to VMware server.
Parameters: |
|
---|---|
Raises: | VimConnectionException, ImageTransferException, ValueError |
oslo_vmware.image_transfer.
download_image
(image, image_meta, session, datastore, rel_path, bypass=True, timeout_secs=7200)¶Transfer an image to a datastore.
Parameters: |
|
---|
oslo_vmware.image_transfer.
download_stream_optimized_data
(context, timeout_secs, read_handle, **kwargs)¶Download stream optimized data to VMware server.
Parameters: |
|
---|---|
Returns: | managed object reference of the VM created for import to VMware server |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError |
oslo_vmware.image_transfer.
download_stream_optimized_image
(context, timeout_secs, image_service, image_id, **kwargs)¶Download stream optimized image from image service to VMware server.
Parameters: |
|
---|---|
Returns: | managed object reference of the VM created for import to VMware server |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError |
oslo_vmware.image_transfer.
upload_image
(context, timeout_secs, image_service, image_id, owner_id, **kwargs)¶Upload the VM’s disk file to image service.
Parameters: |
|
---|---|
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException, ImageTransferException, ValueError |
oslo_vmware.image_util.
get_vmdk_name_from_ovf
(ovf_handle)¶Get the vmdk name from the given ovf descriptor.
VMware PBM service client and PBM related utility methods
PBM is used for policy based placement in VMware datastores. Refer http://goo.gl/GR2o6U for more details.
oslo_vmware.pbm.
Pbm
(protocol='https', host='localhost', port=443, wsdl_url=None, cacert=None, insecure=True, pool_maxsize=10, connection_timeout=None, op_id_prefix='oslo.vmware')¶Bases: oslo_vmware.service.Service
Service class that provides access to the Storage Policy API.
retrieve_service_content
()¶Set the specified vCenter session cookie in the SOAP header
Parameters: | cookie – cookie to set |
---|
oslo_vmware.pbm.
convert_datastores_to_hubs
(pbm_client_factory, datastores)¶Convert given datastore morefs to PbmPlacementHub morefs.
Parameters: |
|
---|---|
Returns: | list of PbmPlacementHub morefs |
oslo_vmware.pbm.
filter_datastores_by_hubs
(hubs, datastores)¶Get filtered subset of datastores corresponding to the given hub list.
Parameters: |
|
---|---|
Returns: | subset of datastores corresponding to the given hub list |
oslo_vmware.pbm.
filter_hubs_by_profile
(session, hubs, profile_id)¶Filter and return hubs that match the given profile.
Parameters: |
|
---|---|
Returns: | subset of hubs that match the given profile |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.pbm.
get_all_profiles
(session)¶Get all the profiles defined in VC server.
Returns: | PbmProfile data objects |
---|---|
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.pbm.
get_pbm_wsdl_location
(vc_version)¶Return PBM WSDL file location corresponding to VC version.
Parameters: | vc_version – a dot-separated version string. For example, “1.2”. |
---|---|
Returns: | the pbm wsdl file location. |
oslo_vmware.pbm.
get_profile_id_by_name
(session, profile_name)¶Get the profile UUID corresponding to the given profile name.
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 |
oslo_vmware.pbm.
get_profiles
(session, vm)¶Query storage profiles associated with the given vm.
Parameters: |
|
---|---|
Returns: | profile IDs |
oslo_vmware.pbm.
get_profiles_by_ids
(session, profile_ids)¶Get storage profiles by IDs.
Parameters: |
|
---|---|
Returns: | profile objects |
Classes defining read and write handles for image transfer.
This module defines various classes for reading and writing files including VMDK files in VMware servers. It also contains a class to read images from glance server.
oslo_vmware.rw_handles.
FileHandle
(file_handle)¶Bases: object
Base class for VMware server file (including VMDK) access over HTTP.
This class wraps a backing file handle and provides utility methods for various sub-classes.
close
()¶Close the file handle.
get_size
()¶Get size of the file to be read.
Raises: | NotImplementedError |
---|
read
(chunk_size)¶Read a chunk of data.
Parameters: | chunk_size – read chunk size |
---|---|
Raises: | NotImplementedError |
write
(data)¶Write data to the file.
Parameters: | data – data to be written |
---|---|
Raises: | NotImplementedError |
oslo_vmware.rw_handles.
FileWriteHandle
(host, port, data_center_name, datastore_name, cookies, file_path, file_size, scheme='https', cacerts=False, thumbprint=None)¶Bases: oslo_vmware.rw_handles.FileHandle
Write handle for a file in VMware server.
close
()¶Get the response and close the connection.
write
(data)¶Write data to the file.
Parameters: | data – data to be written |
---|---|
Raises: | VimConnectionException, VimException |
oslo_vmware.rw_handles.
ImageReadHandle
(glance_read_iter)¶Bases: object
Read handle for glance images.
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.
oslo_vmware.rw_handles.
VmdkHandle
(session, lease, url, file_handle)¶Bases: oslo_vmware.rw_handles.FileHandle
VMDK handle based on HttpNfcLease.
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.
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
---|
oslo_vmware.rw_handles.
VmdkReadHandle
(session, host, port, vm_ref, vmdk_path, vmdk_size)¶Bases: oslo_vmware.rw_handles.VmdkHandle
VMDK read handle based on HttpNfcLease.
close
()¶Releases the lease and close the connection.
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
---|
read
(chunk_size)¶Read a chunk of data from the VMDK file.
Parameters: | chunk_size – size of read chunk |
---|---|
Returns: | the data |
Raises: | VimException |
oslo_vmware.rw_handles.
VmdkWriteHandle
(session, host, port, rp_ref, vm_folder_ref, import_spec, vmdk_size, http_method='PUT')¶Bases: oslo_vmware.rw_handles.VmdkHandle
VMDK write handle based on HttpNfcLease.
This class creates a vApp in the specified resource pool and uploads the virtual disk contents.
close
()¶Releases the lease and close the connection.
Raises: | VimAttributeException, VimSessionOverLoadException, VimConnectionException |
---|
get_imported_vm
()¶“Get managed object reference of the VM created for import.
write
(data)¶Write data to the file.
Parameters: | data – data to be written |
---|---|
Raises: | VimConnectionException, VimException |
Common classes that provide access to vSphere services.
oslo_vmware.service.
LocalFileAdapter
(pool_maxsize=10)¶Bases: requests.adapters.HTTPAdapter
Transport adapter for local files.
See http://stackoverflow.com/a/22989322
send
(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)¶Sends request for a local file.
oslo_vmware.service.
MemoryCache
¶Bases: suds.cache.ObjectCache
get
(key)¶Retrieves the value for a key or None.
put
(key, value, time=3600)¶Sets the value for a key.
oslo_vmware.service.
RequestsTransport
(cacert=None, insecure=True, pool_maxsize=10, connection_timeout=None)¶Bases: suds.transport.Transport
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.
oslo_vmware.service.
Response
(stream, status=200, headers=None)¶Bases: _io.BytesIO
Response with an input stream as source.
get_all
(name, default)¶getheaders
(name)¶info
()¶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
()¶oslo_vmware.service.
Service
(wsdl_url=None, soap_url=None, cacert=None, insecure=True, pool_maxsize=10, connection_timeout=None, op_id_prefix='oslo.vmware')¶Bases: object
Base class containing common functionality for invoking vSphere services
build_base_url
(protocol, host, port)¶Return the vCenter session cookie.
service_content
¶oslo_vmware.service.
ServiceMessagePlugin
¶Bases: suds.plugin.MessagePlugin
Suds plug-in handling some special cases while calling VI SDK.
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.
Parameters: | node – XML value node |
---|
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.
Parameters: | context – send context |
---|
prune
(el)¶oslo_vmware.service.
SudsLogFilter
(name='')¶Bases: logging.Filter
Filter to mask/truncate vCenter credentials in suds logs.
filter
(record)¶Determine if the specified record is to be logged.
Is the specified record to be logged? Returns 0 for no, nonzero for yes. If deemed appropriate, the record may be modified in-place.
oslo_vmware.vim.
Vim
(protocol='https', host='localhost', port=None, wsdl_url=None, cacert=None, insecure=True, pool_maxsize=10, connection_timeout=None, op_id_prefix='oslo.vmware')¶Bases: oslo_vmware.service.Service
Service class that provides access to the VIM API.
retrieve_service_content
()¶The VMware API utility module.
oslo_vmware.vim_util.
WithRetrieval
(vim, retrieve_result)¶Bases: object
Context to retrieve results.
This context provides an iterator to retrieve results and cancel (when needed) retrieve operation on __exit__.
Example:
- with WithRetrieval(vim, retrieve_result) as objects:
- for obj in objects:
- # Use obj
oslo_vmware.vim_util.
build_object_spec
(client_factory, root_folder, traversal_specs)¶Builds the object spec.
Parameters: |
|
---|---|
Returns: | object spec |
oslo_vmware.vim_util.
build_property_filter_spec
(client_factory, property_specs, object_specs)¶Builds the property filter spec.
Parameters: |
|
---|---|
Returns: | property filter spec |
oslo_vmware.vim_util.
build_property_spec
(client_factory, type_='VirtualMachine', properties_to_collect=None, all_properties=False)¶Builds the property spec.
Parameters: |
|
---|---|
Returns: | property spec |
oslo_vmware.vim_util.
build_recursive_traversal_spec
(client_factory)¶Builds recursive traversal spec to traverse managed object hierarchy.
Parameters: | client_factory – factory to get API input specs |
---|---|
Returns: | recursive traversal spec |
oslo_vmware.vim_util.
build_selection_spec
(client_factory, name)¶Builds the selection spec.
Parameters: |
|
---|---|
Returns: | selection spec |
oslo_vmware.vim_util.
build_traversal_spec
(client_factory, name, type_, path, skip, select_set)¶Builds the traversal spec.
Parameters: |
|
---|---|
Returns: | traversal spec |
oslo_vmware.vim_util.
cancel_retrieval
(vim, retrieve_result)¶Cancels the retrieve operation if necessary.
Parameters: |
|
---|---|
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.vim_util.
continue_retrieval
(vim, retrieve_result)¶Continue retrieving results, if available.
Parameters: |
|
---|---|
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.vim_util.
find_extension
(vim, key)¶Looks for an existing extension.
Parameters: |
|
---|---|
Returns: | the data object Extension or None |
oslo_vmware.vim_util.
get_http_service_request_spec
(client_factory, method, uri)¶Build a HTTP service request spec.
Parameters: |
|
---|
oslo_vmware.vim_util.
get_inventory_path
(vim, entity_ref, max_objects=100)¶Get the inventory path of a managed entity.
Parameters: |
|
---|---|
Returns: | inventory path of the entity_ref |
oslo_vmware.vim_util.
get_moref
(value, type_)¶Get managed object reference.
Parameters: |
|
---|---|
Returns: | managed object reference with given value and type |
oslo_vmware.vim_util.
get_obj_spec
(client_factory, obj, select_set=None)¶Builds the Object Spec object.
oslo_vmware.vim_util.
get_object_properties
(vim, moref, properties_to_collect, skip_op_id=False)¶Get properties of the given managed object.
Parameters: |
|
---|---|
Returns: | properties of the given managed object |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.vim_util.
get_object_properties_dict
(vim, moref, properties_to_collect)¶Get properties of the given managed object as a dict.
Parameters: |
|
---|---|
Returns: | a dict of properties of the given managed object |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.vim_util.
get_object_property
(vim, moref, property_name, skip_op_id=False)¶Get property of the given managed object.
Parameters: |
|
---|---|
Returns: | property of the given managed object |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.vim_util.
get_objects
(vim, type_, max_objects, properties_to_collect=None, all_properties=False)¶Get all managed object references of the given type.
It is the caller’s responsibility to continue or cancel retrieval.
Parameters: |
|
---|---|
Returns: | all managed object references of the given type |
Raises: | VimException, VimFaultException, VimAttributeException, VimSessionOverLoadException, VimConnectionException |
oslo_vmware.vim_util.
get_prop_filter_spec
(client_factory, obj_spec, prop_spec)¶Builds the Property Filter Spec Object.
oslo_vmware.vim_util.
get_prop_spec
(client_factory, spec_type, properties)¶Builds the Property Spec Object.
oslo_vmware.vim_util.
get_properties_for_a_collection_of_objects
(vim, type_, obj_list, properties, max_objects=None)¶Gets the list of properties for the collection of objects of the type specified.
oslo_vmware.vim_util.
get_vc_version
(session)¶Return the dot-separated vCenter version string. For example, “1.2”.
Parameters: | session – vCenter soap session |
---|---|
Returns: | vCenter version |
oslo_vmware.vim_util.
propset_dict
(propset)¶Turn a propset list into a dictionary
PropSet is an optional attribute on ObjectContent objects that are returned by the VMware API.
You can read more about these at: | http://pubs.vmware.com/vsphere-51/index.jsp | #com.vmware.wssdk.apiref.doc/ | vmodl.query.PropertyCollector.ObjectContent.html
Parameters: | propset – a property “set” from ObjectContent |
---|---|
Returns: | dictionary representing property set |
oslo_vmware.vim_util.
register_extension
(vim, key, type, label='OpenStack', summary='OpenStack services', version='1.0')¶Create a new extension.
Parameters: |
|
---|
oslo_vmware.vim_util.
storage_placement_spec
(client_factory, dsc_ref, type, clone_spec=None, config_spec=None, relocate_spec=None, vm_ref=None, folder=None, clone_name=None, res_pool_ref=None, host_ref=None)¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.