### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »

# vmware Package

## `vmware` Package

## `appliance_client` Module

class `com.vmware.appliance_client.``Monitoring`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  `Monitoring` class provides methods Get and list monitoring data for requested item.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FunctionType`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    `Monitoring.FunctionType` class Defines aggregation function

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `FunctionType` instance.

    `AVG` = FunctionType(string=u'AVG')

      Aggregation takes average per period

    `COUNT` = FunctionType(string=u'COUNT')

      Aggregation takes count per period (sum)

    `MAX` = FunctionType(string=u'MAX')

      Aggregation takes maximums per period

    `MIN` = FunctionType(string=u'MIN')

      Aggregation takes minimums per period

  class `Monitoring.``IntervalType`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    `Monitoring.IntervalType` class Defines interval between the values in hours and mins, for which aggregation will apply

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `IntervalType` instance.

    `DAY1` = IntervalType(string=u'DAY1')

      24 hours interval between values. One year has 365 values.

    `HOURS2` = IntervalType(string=u'HOURS2')

      Two hours interval between values. One month has 360 values.

    `HOURS6` = IntervalType(string=u'HOURS6')

      Six hour interval between values. One quarter is 360 values.

    `MINUTES30` = IntervalType(string=u'MINUTES30')

      Thirty minutes interval between values. One week is 336 values.

    `MINUTES5` = IntervalType(string=u'MINUTES5')

      Five minutes interval between values (finest). One day would have 288 values, one week is 2016.

  class `Monitoring.``MonitoredItem`(id=None, name=None, units=None, category=None, instance=None, description=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    `Monitoring.MonitoredItem` class Structure representing requested monitored item data.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | id (`str`) – monitored item ID Ex: CPU, MEMORY When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.appliance.monitoring`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.appliance.monitoring`. name (`str`) – monitored item name Ex: “Network write speed” units (`str`) – Y-axis label EX: “Mbps”, “%” category (`str`) – category Ex: network, storage etc instance (`str`) – instance name Ex: eth0 description (`str`) – monitored item description Ex: com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0

  class `Monitoring.``MonitoredItemData`(name=None, interval=None, function=None, start_time=None, end_time=None, data=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    `Monitoring.MonitoredItemData` class Structure representing monitored item data.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str`) – Monitored item IDs Ex: CPU, MEMORY, STORAGE_TOTAL When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.appliance.monitoring`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.appliance.monitoring`. interval (`Monitoring.IntervalType`) – interval between values in hours, minutes function (`Monitoring.FunctionType`) – aggregation function start_time (`datetime.datetime`) – Starting time end_time (`datetime.datetime`) – Ending time data (`list` of `str`) – list of values

  class `Monitoring.``MonitoredItemDataRequest`(names=None, interval=None, function=None, start_time=None, end_time=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    `Monitoring.MonitoredItemDataRequest` class Structure representing requested monitored item data.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | names (`list` of `str`) – monitored item IDs Ex: CPU, MEMORY When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `com.vmware.appliance.monitoring`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `com.vmware.appliance.monitoring`. interval (`Monitoring.IntervalType`) – interval between values in hours, minutes function (`Monitoring.FunctionType`) – aggregation function start_time (`datetime.datetime`) – Starting time end_time (`datetime.datetime`) – Ending time

  `Monitoring.``get`(stat_id)

    Get monitored item info

    Parameters: | stat_id (`str`) – statistic item id The parameter must be an identifier for the resource type: `com.vmware.appliance.monitoring`.
    Return type: | `Monitoring.MonitoredItem`
    Returns: | MonitoredItem structure
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Monitoring.``list`()

    Get monitored items list

    Return type: | `list` of `Monitoring.MonitoredItem`
    Returns: | list of names
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

  `Monitoring.``query`(item)

    Get monitoring data.

    Parameters: | item (`Monitoring.MonitoredItemDataRequest`) – MonitoredItemDataRequest Structure
    Return type: | `list` of `Monitoring.MonitoredItemData`
    Returns: | list of MonitoredItemData structure
    Raise : | `com.vmware.vapi.std.errors_client.Error` Generic error

## `cis_client` Module

class `com.vmware.cis_client.``Session`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Session` class allows API clients to manage session tokens including creating, deleting and obtaining information about sessions.

  - The `Session.create()` method creates session token in exchange for another authentication token.
  - The `Session.delete()` method invalidates a session token.
  - The `Session.get()` retrieves information about a session token.

  The call to the `Session.create()` method is part of the overall authentication process for API clients. For example, the sequence of steps for establishing a session with SAML token is:

  - Connect to lookup service.
  - Discover the secure token service (STS) endpoint URL.
  - Connect to the secure token service to obtain a SAML token.
  - Authenticate to the lookup service using the obtained SAML token.
  - Discover the API endpoint URL from lookup service.
  - Call the `Session.create()` method. The `Session.create()` call must include the SAML token.

  See the programming guide and samples for additional information about establishing API sessions.

  > Execution Context and Security Context

  To use session based authentication a client should supply the session token obtained through the `Session.create()` method. The client should add the session token in the security context when using SDK classes. Clients using the REST API should supply the session token as a HTTP header.

  > Session Lifetime

  A session begins with call to the `Session.create()` method to exchange a SAML token for a API session token. A session ends under the following circumstances:

  - Call to the `Session.delete()` method.
  - The session expires. Session expiration may be caused by one of the following situations:
  - Client inactivity - For a particular session identified by client requests that specify the associated session ID, the lapsed time since the last request exceeds the maximum interval between requests.
  - Unconditional or absolute session expiration time: At the beginning of the session, the session logic uses the SAML token and the system configuration to calculate absolute expiration time.

  When a session ends, the authentication logic will reject any subsequent client requests that specify that session. Any operations in progress will continue to completion.

  > Error Handling

  > The `Session` returns the following exceptions:

  - `com.vmware.vapi.std.errors_client.Unauthenticated` exception for any exceptions related to the request.
  - `com.vmware.vapi.std.errors_client.ServiceUnavailable` exception for all exceptions caused by internal service failure.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `Info`(user=None, created_time=None, last_accessed_time=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    Represents data associated with an API session.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | user (`str`) – Fully qualified name of the end user that created the session, for example Administrator\@vsphere.local. A typical use case for this information is in Graphical User Interfaces (GUI) or logging systems to visualize the identity of the current user. created_time (`datetime.datetime`) – Time when the session was created. last_accessed_time (`datetime.datetime`) – Last time this session was used by passing the session key for invoking an API.

  `Session.``create`()

    Creates a session with the API. This is the equivalent of login. This method exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

    Return type: | `str`
    Returns: | Newly created session identifier to be used for authenticating further requests.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the session creation fails due to request specific issues. Due to the security nature of the API the details of the error are not disclosed. Please check the following preconditions if using a SAML token to authenticate: the supplied token is delegate-able. the time of client and server system are synchronized. the token supplied is valid. if bearer tokens are used check that system configuration allows the API endpoint to accept such tokens.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if session creation fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the exception. Please refer to component health information, administrative logs and product specific documentation for possible causes.

  `Session.``delete`()

    Terminates the validity of a session token. This is the equivalent of log out.

    > A session identifier is expected as part of the request.

    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the session id is missing from the request or the corresponding session object cannot be found.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if session deletion fails due to server specific issues, for example connection to a back end component is failing. Due to the security nature of this API further details will not be disclosed in the exception. Please refer to component health information, administrative logs and product specific documentation for possible causes.

  `Session.``get`()

    Returns information about the current session. This method expects a valid session identifier to be supplied.

    A side effect of invoking this method may be a change to the session’s last accessed time to the current time if this is supported by the session implementation. Invoking any other method in the API will also update the session’s last accessed time.

    This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

    Return type: | `Session.Info`
    Returns: | Information about the session.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the session id is missing from the request or the corresponding session object cannot be found.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if session retrieval fails due to server specific issues e.g. connection to back end component is failing. Due to the security nature of this API further details will not be disclosed in the error. Please refer to component health information, administrative logs and product specific documentation for possible causes.

## `content_client` Module

The Content module provides classes and classes for configuring global settings and permissions, and for managing libraries in the Content Library Service.

class `com.vmware.content_client.``Configuration`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Configuration` class provides methods to configure the global settings of the Content Library Service.

  The configuration settings are used by the Content Library Service to control the behavior of various operations.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  `get`()

    Retrieves the current configuration values.

    Return type: | `ConfigurationModel`
    Returns: | The `ConfigurationModel` instance representing the configuration of the Content Library Service.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `ContentLibrary.GetConfiguration`.

  `update`(model)

    Updates the configuration. The update is incremental. Any attribute in the `ConfigurationModel` class that is None will not be modified. Note that this update method doesn’t guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

    Parameters: | model (`ConfigurationModel`) – The `ConfigurationModel` specifying the settings to update.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if one of the configuration properties is not within the proper range.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `ContentLibrary.UpdateConfiguration`.

class `com.vmware.content_client.``ConfigurationModel`(automatic_sync_enabled=None, automatic_sync_start_hour=None, automatic_sync_stop_hour=None, maximum_concurrent_item_syncs=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `ConfigurationModel` class defines the global settings of the Content Library Service.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | automatic_sync_enabled (`bool`) – Whether automatic synchronization is enabled. When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the `com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled` flag turned on will be synchronized every hour between `ConfigurationModel.automatic_sync_start_hour` and `ConfigurationModel.automatic_sync_stop_hour`. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. automatic_sync_start_hour (`long`) – The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. automatic_sync_stop_hour (`long`) – The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. maximum_concurrent_item_syncs (`long`) – The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity. This setting is global across all subscribed libraries. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method.

class `com.vmware.content_client.``Library`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Library` class provides methods to manage and find `LibraryModel` entities.

  The `Library` class provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this class will not affect the properties specific to the type of library. See also `LocalLibrary` and `SubscribedLibrary`.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FindSpec`(name=None, type=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    Specifies the properties that can be used as a filter to find libraries. When multiple attributes are specified, all properties of the library must match the specification.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str` or `None`) – Name of the library to search. The name is case-insensitive. See `LibraryModel.name`. If not specified any name will be searched. type (`LibraryModel.LibraryType` or `None`) – Library type to search. See `LibraryModel.type`. If not specified any library type will be searched.

  `Library.``RESOURCE_TYPE` = 'com.vmware.content.Library'

    Resource type for library.

  `Library.``find`(spec)

    Returns a list of all the visible (as determined by authorization policy) libraries matching the requested `Library.FindSpec`.

    Parameters: | spec (`Library.FindSpec`) – Specification describing what properties to filter on.
    Return type: | `list` of `str`
    Returns: | The `list` of identifiers of all the visible libraries matching the given `spec`. The return value will contain identifiers for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if no properties are specified in the `spec`.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`.

  `Library.``get`(library_id)

    Returns a given `LibraryModel`.

    Parameters: | library_id (`str`) – Identifier of the library to return. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Return type: | `LibraryModel`
    Returns: | The `LibraryModel` instance with the specified `library_id`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the specified library does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `System.Read`.

  `Library.``list`()

    Returns the identifiers of all libraries of any type in the Content Library.

    Return type: | `list` of `str`
    Returns: | The `list` of all identifiers of all libraries in the Content Library. The return value will contain identifiers for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`.

  `Library.``update`(library_id, update_spec)

    Updates the properties of a library.

    This is an incremental update to the library. Any attribute in the `LibraryModel` class that is None will not be modified.

    This method will only update the common properties for all library types. This will not, for example, update the `LibraryModel.publish_info` of a local library, nor the `LibraryModel.subscription_info` of a subscribed library. Specific properties are updated in `LocalLibrary.update()` and `SubscribedLibrary.update()`.

    Parameters: | library_id (`str`) – Identifier of the library to update. The parameter must be an identifier for the resource type: `com.vmware.content.Library`. update_spec (`LibraryModel`) – Specification of the new property values to set on the library.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library associated with `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `update_spec` is not valid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `LibraryModel.version` of `update_spec` is not equal to the current version of the library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.UpdateLibrary`.

class `com.vmware.content_client.``LibraryModel`(id=None, creation_time=None, description=None, last_modified_time=None, last_sync_time=None, name=None, storage_backings=None, type=None, optimization_info=None, version=None, publish_info=None, subscription_info=None, server_guid=None)

  Bases: `vmware.vapi.bindings.struct.VapiStruct`

  The `LibraryModel` class represents a Content Library resource model.

  A `LibraryModel` is a container for a set of items which represent a usable set of files. The Content Library Service allows for multiple libraries to be created with separate authorization and sharing policies.

  Each `LibraryModel` is a container for a set of `com.vmware.content.library_client.ItemModel` instances. Each item is a logical object in a library, which may have multiple files.

  A `LibraryModel` may be local or subscribed. A local library has its source of truth about items within this Content Library Service. Items may be added to or removed from the library. A local library may also be private or published. When published, the library is exposed by a network endpoint and can be used by another Content Library Service for synchronization. A private local library cannot be used for synchronization.

  A subscribed library is a library which gets its source of truth from another library that may be across a network in another Content Library Service. A subscribed library may have a different name and metadata from the library to which it subscribes, but the set of library items is always the same as those in the source library. Library items cannot be manually added to a subscribed library – they can only be added by adding new items to the source library.

  Tip

  The arguments are used to initialize data attributes with the same names.

  Parameters: | id (`str`) – An identifier which uniquely identifies this `LibraryModel`. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.content.Library`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.content.Library`. This attribute is not used for the `create` method. It will not be present in the return value of the `get` or `list` methods. It is not used for the `update` method. creation_time (`datetime.datetime`) – The date and time when this library was created. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. description (`str`) – A human-readable description for this library. This attribute is optional for the `create` method. Leaving it None during creation will result in an empty string value. It will always be present in the result of a `get` or `list` method. It is optional for the `update` method. Leaving it None during update indicates that the description should be left unchanged. last_modified_time (`datetime.datetime`) – The date and time when this library was last updated. This attribute is updated automatically when the library properties are changed. This attribute is not affected by adding, removing, or modifying a library item or its content within the library. Tagging the library or syncing the subscribed library does not alter this attribute. This attribute is not used for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. last_sync_time (`datetime.datetime`) – The date and time when this library was last synchronized. This attribute applies only to subscribed libraries. It is updated every time a synchronization is triggered on the library. The value is None for a local library. This attribute is not used for the `create` method. It is optional in the return value of the `get` or `list` methods. It is not used for the `update` method. name (`str`) – The name of the library. A Library is identified by a human-readable name. Library names cannot be undefined or an empty string. Names do not have to be unique. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is optional for the `update` method. storage_backings (`list` of `com.vmware.content.library_client.StorageBacking`) – The list of storage backings which are available for this library. A `com.vmware.content.library_client.StorageBacking` defines a storage location which can be used to store files for the library items in this library. Multiple storage locations are not currently supported but may become supported in future releases. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. type (`LibraryModel.LibraryType`) – The type (LOCAL, SUBSCRIBED) of this library. This value can be used to determine what additional services and information can be available for this library. This attribute must be provided for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method. optimization_info (`com.vmware.content.library_client.OptimizationInfo`) – Defines various optimizations and optimization parameters applied to this library. This attribute is optional for the `create` method. It is optional in the return value of the `get` or `list` methods. It is optional for the `update` method. version (`str`) – A version number which is updated on metadata changes. This value allows clients to detect concurrent updates and prevent accidental clobbering of data. This value represents a number which is incremented every time library properties, such as name or description, are changed. It is not incremented by changes to a library item within the library, including adding or removing items. It is also not affected by tagging the library. This attribute is not used for the `create` method. It will always be present in the result of a `get` or `list` method. It is optional for the `update` method. Leaving it None during update indicates that you do not need to detect concurrent updates. publish_info (`com.vmware.content.library_client.PublishInfo`) – Defines how this library is published so that it can be subscribed to by a remote subscribed library. The `com.vmware.content.library_client.PublishInfo` defines where and how the metadata for this local library is accessible. A local library is only published publically if `com.vmware.content.library_client.PublishInfo.published` is `true`. This attribute is optional for the `create` and `update` methods. If not specified during creation, the default is for the library to not be published. If not specified during update, the attribute is left unchanged. subscription_info (`com.vmware.content.library_client.SubscriptionInfo`) – Defines the subscription behavior for this Library. The `com.vmware.content.library_client.SubscriptionInfo` defines how this subscribed library synchronizes to a remote source. Setting the value will determine the remote source to which the library synchronizes, and how. Changing the subscription will result in synchronizing to a new source. If the new source differs from the old one, the old library items and data will be lost. Setting `com.vmware.content.library_client.SubscriptionInfo.automatic_sync_enabled` to false will halt subscription but will not remove existing cached data. This attribute is optional for the `create` and `update` methods. If not specified during creation, a default will be created without an active subscription. If not specified during update, the attribute is left unchanged. server_guid (`str`) – The unique identifier of the vCenter server where the library exists. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `com.vmware.vcenter.VCenter`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `com.vmware.vcenter.VCenter`. This attribute is optional for the `create` method. It will always be present in the return value of the `get` or `list` methods. It is not used for the `update` method.

  class `LibraryType`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `LibraryModel.LibraryType` class defines the type of a `LibraryModel`.

    The type of a library can be used to determine which additional services can be performed with a library.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `LibraryType` instance.

    `LOCAL` = LibraryType(string=u'LOCAL')

      The library contents are defined and stored by the local Content Library Service installation.

      A local library can be retrieved and managed via the `LocalLibrary`.

    `SUBSCRIBED` = LibraryType(string=u'SUBSCRIBED')

      The library synchronizes its items and content from another published library.

      A subscribed library can be retrieved and managed via the `SubscribedLibrary`.

class `com.vmware.content_client.``LocalLibrary`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `LocalLibrary` class manages local libraries.

  The `LocalLibrary` class provides support for creating and maintaining local library instances. A local library may also use the `Library` class to manage general library functionality.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  `create`(create_spec, client_token=None)

    Creates a new local library.

    Parameters: | client_token (`str` or `None`) – A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: `b8a2a2e3-2314-43cd-a871-6ede0f429751`. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent. create_spec (`LibraryModel`) – Specification for the new local library.
    Return type: | `str`
    Returns: | Identifier of the newly created `LibraryModel`. The return value will be an identifier for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `create_spec` is not valid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `client_token` does not conform to the UUID format.
    Raise : | `com.vmware.vapi.std.errors_client.Unsupported` if using multiple storage backings.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `ContentLibrary.CreateLocalLibrary`.

  `delete`(library_id)

    Deletes the specified local library.

    Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

    Parameters: | library_id (`str`) – Identifier of the local library to delete. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library specified by `library_id` is not a local library.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library specified by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.DeleteLocalLibrary`.

  `get`(library_id)

    Returns a given local library.

    Parameters: | library_id (`str`) – Identifier of the local library to return. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Return type: | `LibraryModel`
    Returns: | The `LibraryModel` instance associated with `library_id`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library specified by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library specified by `library_id` is not a local library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `System.Read`.

  `list`()

    Returns the identifiers of all local libraries in the Content Library.

    Return type: | `list` of `str`
    Returns: | The `list` of identifiers of all local libraries in the Content Library. The return value will contain identifiers for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`.

  `update`(library_id, update_spec)

    Updates the properties of a local library.

    This is an incremental update to the local library. Attributes that are None in the update specification will be left unchanged.

    Parameters: | library_id (`str`) – Identifier of the local library to update. The parameter must be an identifier for the resource type: `com.vmware.content.Library`. update_spec (`LibraryModel`) – Specification of the new property values to set on the local library.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library specified by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library specified by `library_id` is not a local library.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `update_spec` is not valid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `LibraryModel.version` of `update_spec` is not equal to the current version of the library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.UpdateLocalLibrary`.

class `com.vmware.content_client.``SubscribedLibrary`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `ProbeResult`(status=None, ssl_thumbprint=None, error_messages=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `SubscribedLibrary.ProbeResult` class defines the subscription information probe result. This describes whether using a given subscription URL is successful or if there are access problems, such as SSL errors.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | status (`SubscribedLibrary.ProbeResult.Status`) – The status of probe result. This will be one of SUCCESS, INVALID_URL, TIMED_OUT, HOST_NOT_FOUND, RESOURCE_NOT_FOUND, INVALID_CREDENTIALS, CERTIFICATE_ERROR, UNKNOWN_ERROR. ssl_thumbprint (`str` or `None`) – The SSL thumbprint for the remote endpoint. An SSL thumbprint is only returned if the host is secured with SSL/TLS. error_messages (`list` of `com.vmware.vapi.std_client.LocalizableMessage`) – If the probe result is in an error status, this attribute will contain the detailed error messages.

    class `Status`(string)

      Bases: `vmware.vapi.bindings.enum.Enum`

      The `SubscribedLibrary.ProbeResult.Status` class defines the error status constants for the probe result.

      Note

      This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

      Parameters: | string (`str`) – String value for the `Status` instance.

      `CERTIFICATE_ERROR` = Status(string=u'CERTIFICATE_ERROR')

        Indicates that the provided server certificate thumbprint in `com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in `com.vmware.content.library_client.SubscriptionInfo.ssl_thumbprint`.

      `HOST_NOT_FOUND` = Status(string=u'HOST_NOT_FOUND')

        Indicates that the host in the URL could not be found.

      `INVALID_CREDENTIALS` = Status(string=u'INVALID_CREDENTIALS')

        Indicates that the connection was rejected due to invalid credentials.

      `INVALID_URL` = Status(string=u'INVALID_URL')

        Indicates that the supplied URL was not valid.

      `RESOURCE_NOT_FOUND` = Status(string=u'RESOURCE_NOT_FOUND')

        Indicates that the given resource at the URL was not found.

      `SUCCESS` = Status(string=u'SUCCESS')

        Indicates that the probe was successful.

      `TIMED_OUT` = Status(string=u'TIMED_OUT')

        Indicates that the probe timed out while attempting to connect to the URL.

      `UNKNOWN_ERROR` = Status(string=u'UNKNOWN_ERROR')

        Indicates an unspecified error different from the other error cases defined in `SubscribedLibrary.ProbeResult.Status`.

  `SubscribedLibrary.``create`(create_spec, client_token=None)

    Creates a new subscribed library.

    Once created, the subscribed library will be empty. If the `LibraryModel.subscription_info` property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

    Parameters: | client_token (`str` or `None`) – Unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: `b8a2a2e3-2314-43cd-a871-6ede0f429751`. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent. create_spec (`LibraryModel`) – Specification for the new subscribed library.
    Return type: | `str`
    Returns: | Identifier of the newly created subscribed library. The return value will be an identifier for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `create_spec` is not valid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `client_token` does not conform to the UUID format.
    Raise : | `com.vmware.vapi.std.errors_client.Unsupported` if using multiple storage backings.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if subscribing to a published library which cannot be accessed.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `ContentLibrary.CreateSubscribedLibrary`.

  `SubscribedLibrary.``delete`(library_id)

    Deletes the specified subscribed library.

    Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

    Parameters: | library_id (`str`) – Identifier of the subscribed library to delete. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library referenced by `library_id` is not a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library referenced by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.DeleteSubscribedLibrary`.

  `SubscribedLibrary.``evict`(library_id)

    Evicts the cached content of an on-demand subscribed library.

    This method allows the cached content of a subscribed library to be removed to free up storage capacity. This method will only work when a subscribed library is synchronized on-demand.

    Parameters: | library_id (`str`) – Identifier of the subscribed library whose content should be evicted. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library specified by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library specified by `library_id` is not a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.NotAllowedInCurrentState` if the library specified by `library_id` does not synchronize on-demand.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.EvictSubscribedLibrary`.

  `SubscribedLibrary.``get`(library_id)

    Returns a given subscribed library.

    Parameters: | library_id (`str`) – Identifier of the subscribed library to return. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Return type: | `LibraryModel`
    Returns: | The `LibraryModel` instance that corresponds to `library_id`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library associated with `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library associated with `library_id` is not a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `System.Read`.

  `SubscribedLibrary.``list`()

    Returns the identifiers of all subscribed libraries in the Content Library.

    Return type: | `list` of `str`
    Returns: | The `list` of identifiers of all subscribed libraries in the Content Library. The return value will contain identifiers for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `System.Read`.

  `SubscribedLibrary.``probe`(subscription_info)

    Probes remote library subscription information, including URL, SSL certificate and password. The resulting `SubscribedLibrary.ProbeResult` class describes whether or not the subscription configuration is successful.

    Parameters: | subscription_info (`com.vmware.content.library_client.SubscriptionInfo`) – The subscription info to be probed.
    Return type: | `SubscribedLibrary.ProbeResult`
    Returns: | The subscription info probe result.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `ContentLibrary.ProbeSubscription`.

  `SubscribedLibrary.``sync`(library_id)

    Forces the synchronization of the subscribed library.

    Synchronizing a subscribed library forcefully with this method will perform the same synchronization behavior as would run periodically for the library. The `com.vmware.content.library_client.SubscriptionInfo.on_demand` setting is respected. Calling this method on a library that is already in the process of synchronizing will have no effect.

    Parameters: | library_id (`str`) – Identifier of the subscribed library to synchronize. The parameter must be an identifier for the resource type: `com.vmware.content.Library`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library specified by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library specified by `library_id` is not a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if some parameter in the subscribed library subscription info is invalid.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if the published library cannot be contacted or found.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.SyncLibrary`.

  `SubscribedLibrary.``update`(library_id, update_spec)

    Updates the properties of a subscribed library.

    This is an incremental update to the subscribed library. Attributes that are None in the update specification will be left unchanged.

    Parameters: | library_id (`str`) – Identifier of the subscribed library to update. The parameter must be an identifier for the resource type: `com.vmware.content.Library`. update_spec (`LibraryModel`) – Specification of the new property values to set on the subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the library specified by `library_id` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the library specified by `library_id` is not a subscribed library.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `update_spec` is not valid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `LibraryModel.version` of `update_spec` is not equal to the current version of the library.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if the subscription info is being updated but the published library cannot be contacted or found.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: The resource `com.vmware.content.Library` referenced by the parameter `library_id` requires `ContentLibrary.UpdateSubscribedLibrary`.

class `com.vmware.content_client.``Type`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Type` class exposes the `com.vmware.content.library_client.ItemModel` types that this Content Library Service supports.

  A library item has an optional type which can be specified with the `com.vmware.content.library_client.ItemModel.type` attribute. For items with a type that is supported by a plugin, the Content Library Service may understand the files which are part of the library item and can produce metadata for the item.

  In other cases, uploads may require a process in which one upload implies subsequent uploads. For example, an Open Virtualization Format (OVF) package is composed of an OVF descriptor file and the associated virtual disk files. Uploading an OVF descriptor can enable the Content Library Service to understand that the complete OVF package requires additional disk files, and it can set up the transfers for the disks automatically by adding the file entries for the disks when the OVF descriptor is uploaded.

  When a type is not supported by a plugin, or the type is not specified, the Content Library Service can handle a library item in a default way, without adding metadata to the item or guiding the upload process.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `Info`(description=None, name=None, type=None, vendor=None, version=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Type.Info` class describes support for a specific type of data in an `com.vmware.content.library_client.ItemModel`. The `Type.Info` can be queried through the `Type` class. Type support describes plugins in the Content Library which can provide metadata on library items and help manage the transfer process by adding dependent files when a current file is added.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | description (`str`) – A description of the type support offered by the plugin. name (`str`) – The name of the plugin which provides the type support. type (`str`) – The type which the plugin supports. To upload a library item of the type supported by the plugin, the `com.vmware.content.library_client.ItemModel.type` attribute of the item should be set to this value. vendor (`str`) – The name of the vendor who created the type support plugin. version (`str`) – The version number of the type support plugin.

  `Type.``list`()

    Returns a `list` of `Type.Info` instances which describe the type support plugins in this Content Library.

    Return type: | `list` of `Type.Info`
    Returns: | The `list` of `Type.Info` instances which describe the type support plugins in this Content Library.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if you do not have all of the privileges described as follows: Method execution requires `ContentLibrary.TypeIntrospection`.

## `vapi_client` Module

The `com.vmware.vapi_client` component provides API infrastructure classes and standard types that can be used in the interface specification of any class.

## `vcenter_client` Module

The `com.vmware.vcenter_client` module provides classes for managing VMware vSphere environments. The module is available starting in vSphere 6.5.

class `com.vmware.vcenter_client.``Cluster`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Cluster` class provides methods to manage clusters in the vCenter Server.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FilterSpec`(clusters=None, names=None, folders=None, datacenters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Cluster.FilterSpec` class contains attributes used to filter the results when listing clusters (see `Cluster.list()`). If multiple attributes are specified, only clusters matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | clusters (`set` of `str` or `None`) – Identifiers of clusters that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ClusterComputeResource`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ClusterComputeResource`. If None or empty, clusters with any identifier match the filter. names (`set` of `str` or `None`) – Names that clusters must have to match the filter (see `Cluster.Info.name`). If None or empty, clusters with any name match the filter. folders (`set` of `str` or `None`) – Folders that must contain the cluster for the cluster to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, clusters in any folder match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the cluster for the cluster to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, clusters in any datacenter match the filter.

  class `Cluster.``Info`(name=None, resource_pool=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Cluster.Info` class contains information about a cluster in vCenter Server.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str`) – The name of the cluster resource_pool (`str`) – Identifier of the root resource pool of the cluster When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `ResourcePool`.

  `Cluster.``RESOURCE_TYPE` = 'ClusterComputeResource'

    The resource type for the vCenter Cluster

  class `Cluster.``Summary`(cluster=None, name=None, ha_enabled=None, drs_enabled=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Cluster.Summary` class contains commonly used information about a cluster in vCenter Server.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | cluster (`str`) – Identifier of the cluster. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `ClusterComputeResource`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `ClusterComputeResource`. name (`str`) – Name of the cluster. ha_enabled (`bool`) – Flag indicating whether the vSphere HA feature is enabled for the cluster. drs_enabled (`bool`) – Flag indicating whether the vSphere DRS service is enabled for the cluster.

  `Cluster.``get`(cluster)

    Retrieves information about the cluster corresponding to `cluster`.

    Parameters: | cluster (`str`) – Identifier of the cluster. The parameter must be an identifier for the resource type: `ClusterComputeResource`.
    Return type: | `Cluster.Info`
    Returns: | The `Cluster.Info` instances that corresponds to the `cluster`.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if there is no cluster associated with `cluster` in the system.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the session id is missing from the request or the corresponding session object cannot be found.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t not have the required privileges.

  `Cluster.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the `Cluster.FilterSpec`.

    Parameters: | filter (`Cluster.FilterSpec` or `None`) – Specification of matching clusters for which information should be returned. If None, the behavior is equivalent to a `Cluster.FilterSpec` with all attributes None which means all clusters match the filter.
    Return type: | `list` of `Cluster.Summary`
    Returns: | Commonly used information about the clusters matching the `Cluster.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 clusters match the `Cluster.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``Datacenter`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Datacenter` class provides methods to manage datacenters in the vCenter Server.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `CreateSpec`(name=None, folder=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datacenter.CreateSpec` class defines the information used to create a datacenter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str`) – The name of the datacenter to be created. folder (`str` or `None`) – Datacenter folder in which the new datacenter should be created. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. This attribute is currently required. In the future, if this attribute is None, the system will attempt to choose a suitable folder for the datacenter; if a folder cannot be chosen, the datacenter creation operation will fail.

  class `Datacenter.``FilterSpec`(datacenters=None, names=None, folders=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datacenter.FilterSpec` class contains attributes used to filter the results when listing datacenters (see `Datacenter.list()`). If multiple attributes are specified, only datacenters matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | datacenters (`set` of `str` or `None`) – Identifiers of datacenters that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, datacenters with any identifier match the filter. names (`set` of `str` or `None`) – Names that datacenters must have to match the filter (see `Datacenter.Info.name`). If None or empty, datacenters with any name match the filter. folders (`set` of `str` or `None`) – Folders that must contain the datacenters for the datacenter to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, datacenters in any folder match the filter.

  class `Datacenter.``Info`(name=None, datastore_folder=None, host_folder=None, network_folder=None, vm_folder=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datacenter.Info` class contains information about a datacenter in vCenter Server.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str`) – The name of the datacenter. datastore_folder (`str`) – The root datastore folder associated with the datacenter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. host_folder (`str`) – The root host and cluster folder associated with the datacenter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. network_folder (`str`) – The root network folder associated with the datacenter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. vm_folder (`str`) – The root virtual machine folder associated with the datacenter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`.

  `Datacenter.``RESOURCE_TYPE` = 'Datacenter'

    The resource type for the vCenter Datacenter

  class `Datacenter.``Summary`(datacenter=None, name=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datacenter.Summary` class contains commonly used information about a datacenter in vCenter Server.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | datacenter (`str`) – Identifier of the datacenter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Datacenter`. name (`str`) – Name of the datacenter.

  `Datacenter.``create`(spec)

    Create a new datacenter in the vCenter inventory

    Parameters: | spec (`Datacenter.CreateSpec`) – Specification for the new datacenter to be created.
    Return type: | `str`
    Returns: | The identifier of the newly created datacenter The return value will be an identifier for the resource type: `Datacenter`.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.AlreadyExists` if the datacenter with the same name is already present.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the datacenter name is empty or invalid as per the underlying implementation.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the folder is not specified and the system cannot choose a suitable one.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the datacenter folder cannot be found.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Datacenter.``delete`(datacenter, force=None)

    Delete an empty datacenter from the vCenter Server

    Parameters: | datacenter (`str`) – Identifier of the datacenter to be deleted. The parameter must be an identifier for the resource type: `Datacenter`. force (`bool` or `None`) – If true, delete the datacenter even if it is not empty. If None a `com.vmware.vapi.std.errors_client.ResourceInUse` exception will be reported if the datacenter is not empty. This is the equivalent of passing the value false.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if there is no datacenter associated with `datacenter` in the system.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInUse` if the datacenter associated with `datacenter` is not empty.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Datacenter.``get`(datacenter)

    Retrieves information about the datacenter corresponding to `datacenter`.

    Parameters: | datacenter (`str`) – Identifier of the datacenter. The parameter must be an identifier for the resource type: `Datacenter`.
    Return type: | `Datacenter.Info`
    Returns: | The `Datacenter.Info` instances that corresponds to the `datacenter`.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if there is no datacenter associated with `datacenter` in the system.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Datacenter.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the `Datacenter.FilterSpec`.

    Parameters: | filter (`Datacenter.FilterSpec` or `None`) – Specification of matching datacenters for which information should be returned. If None, the behavior is equivalent to a `Datacenter.FilterSpec` with all attributes None which means all datacenters match the filter.
    Return type: | `list` of `Datacenter.Summary`
    Returns: | Commonly used information about the datacenters matching the `Datacenter.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 datacenters match the `Datacenter.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``Datastore`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The Datastore class provides methods for manipulating a datastore.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FilterSpec`(datastores=None, names=None, types=None, folders=None, datacenters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datastore.FilterSpec` class contains attributes used to filter the results when listing datastores (see `Datastore.list()`). If multiple attributes are specified, only datastores matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | datastores (`set` of `str` or `None`) – Identifiers of datastores that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datastore`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datastore`. If None or empty, datastores with any identifier match the filter. names (`set` of `str` or `None`) – Names that datastores must have to match the filter (see `Datastore.Info.name`). If None or empty, datastores with any name match the filter. types (`set` of `Datastore.Type` or `None`) – Types that datastores must have to match the filter (see `Datastore.Summary.type`). If None or empty, datastores with any type match the filter. folders (`set` of `str` or `None`) – Folders that must contain the datastore for the datastore to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, datastores in any folder match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the datastore for the datastore to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, datastores in any datacenter match the filter.

  class `Datastore.``Info`(name=None, type=None, accessible=None, free_space=None, multiple_host_access=None, thin_provisioning_supported=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datastore.Info` class contains information about a datastore.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str`) – Name of the datastore. type (`Datastore.Type`) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datastore. accessible (`bool`) – Whether or not this datastore is accessible. free_space (`long` or `None`) – Available space of this datastore, in bytes. The server periodically updates this value. This attribute will be None if the available space of this datastore is not known. multiple_host_access (`bool`) – Whether or not ore than one host in the datacenter has been configured with access to the datastore. thin_provisioning_supported (`bool`) – Whether or not the datastore supports thin provisioning on a per file basis. When thin provisioning is used, backing storage is lazily allocated.

  `Datastore.``RESOURCE_TYPE` = 'Datastore'

    The resource type for the vCenter datastore

  class `Datastore.``Summary`(datastore=None, name=None, type=None, free_space=None, capacity=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Datastore.Summary` class contains commonly used information about a datastore.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | datastore (`str`) – Identifier of the datastore. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Datastore`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Datastore`. name (`str`) – Name of the datastore. type (`Datastore.Type`) – Type (VMFS, NFS, NFS41, CIFS, VSAN, VFFS, VVOL) of the datatore. free_space (`long` or `None`) – Available space of this datastore, in bytes. The server periodically updates this value. This attribute will be None if the available space of this datastore is not known. capacity (`long` or `None`) – Capacity of this datastore, in bytes. The server periodically updates this value. This attribute will be None if the capacity of this datastore is not known.

  class `Datastore.``Type`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `Datastore.Type` class defines the supported types of vCenter datastores.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `Type` instance.

    `CIFS` = Type(string=u'CIFS')

      Common Internet File System.

    `NFS` = Type(string=u'NFS')

      Network file system v3 (linux & esx servers only).

    `NFS41` = Type(string=u'NFS41')

      Network file system v4.1 (linux & esx servers only).

    `VFFS` = Type(string=u'VFFS')

      Flash Read Cache (ESX Server only).

    `VMFS` = Type(string=u'VMFS')

      VMware File System (ESX Server only).

    `VSAN` = Type(string=u'VSAN')

      Virtual SAN (ESX Server only).

    `VVOL` = Type(string=u'VVOL')

      vSphere Virtual Volume (ESX Server only).

  `Datastore.``get`(datastore)

    Retrieves information about the datastore indicated by `datastore`.

    Parameters: | datastore (`str`) – Identifier of the datastore for which information should be retrieved. The parameter must be an identifier for the resource type: `Datastore`.
    Return type: | `Datastore.Info`
    Returns: | information about the datastore.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the datastore indicated by `datastore` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Datastore.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) datastores in vCenter matching the `Datastore.FilterSpec`.

    Parameters: | filter (`Datastore.FilterSpec` or `None`) – Specification of matching datastores for which information should be returned. If None, the behavior is equivalent to a `Datastore.FilterSpec` with all attributes None which means all datastores match the filter.
    Return type: | `list` of `Datastore.Summary`
    Returns: | Commonly used information about the datastores matching the `Datastore.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `Datastore.FilterSpec.types` attribute contains a value that is not supported by the server.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `Datastore.FilterSpec.types` attribute contains a value that is not supported by the server.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 datastores match the `Datastore.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``Folder`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The Folder class provides methods for manipulating a vCenter Server folder.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FilterSpec`(folders=None, names=None, type=None, parent_folders=None, datacenters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Folder.FilterSpec` class contains attributes used to filter the results when listing folders (see `Folder.list()`). If multiple attributes are specified, only folders matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | folders (`set` of `str` or `None`) – Identifiers of folders that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, folders with any identifier match the filter. names (`set` of `str` or `None`) – Names that folders must have to match the filter (see `Folder.Summary.name`). If None or empty, folders with any name match the filter. type (`Folder.Type` or `None`) – Type that folders must have to match the filter (see `Folder.Summary.type`). If None, folders with any type match the filter. parent_folders (`set` of `str` or `None`) – Folders that must contain the folder for the folder to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, folder in any folder match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the folder for the folder to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, folder in any datacenter match the filter.

  `Folder.``RESOURCE_TYPE` = 'Folder'

    The resource type for the vCenter folder

  class `Folder.``Summary`(folder=None, name=None, type=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Folder.Summary` class contains commonly used information about a folder.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | folder (`str`) – Identifier of the folder. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. name (`str`) – Name of the vCenter Server folder. type (`Folder.Type`) – Type (DATACENTER, DATASTORE, HOST, NETWORK, VIRTUAL_MACHINE) of the vCenter Server folder.

  class `Folder.``Type`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `Folder.Type` class defines the type of a vCenter Server folder. The type of a folder determines what what kinds of children can be contained in the folder.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `Type` instance.

    `DATACENTER` = Type(string=u'DATACENTER')

      A folder that can contain datacenters.

    `DATASTORE` = Type(string=u'DATASTORE')

      A folder that can contain datastores.

    `HOST` = Type(string=u'HOST')

      A folder that can contain compute resources (hosts and clusters).

    `NETWORK` = Type(string=u'NETWORK')

      A folder that can contain networkds.

    `VIRTUAL_MACHINE` = Type(string=u'VIRTUAL_MACHINE')

      A folder that can contain virtual machines.

  `Folder.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the `Folder.FilterSpec`.

    Parameters: | filter (`Folder.FilterSpec` or `None`) – Specification of matching folders for which information should be returned. If None, the behavior is equivalent to a `Folder.FilterSpec` with all attributes None which means all folders match the filter.
    Return type: | `list` of `Folder.Summary`
    Returns: | Commonly used information about the folders matching the `Folder.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `Folder.FilterSpec.type` attribute contains a value that is not supported by the server.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 folders match the `Folder.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``Host`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `Host` class provides methods to manage hosts in the vCenter Server.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `ConnectionState`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `Host.ConnectionState` class defines the connection status of a host.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `ConnectionState` instance.

    `CONNECTED` = ConnectionState(string=u'CONNECTED')

      Host is connected to the vCenter Server

    `DISCONNECTED` = ConnectionState(string=u'DISCONNECTED')

      Host is disconnected from the vCenter Server

    `NOT_RESPONDING` = ConnectionState(string=u'NOT_RESPONDING')

      VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.

  class `Host.``CreateSpec`(hostname=None, port=None, user_name=None, password=None, folder=None, thumbprint_verification=None, thumbprint=None, force_add=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Host.CreateSpec` class defines the information used to create a host.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | hostname (`str`) – The IP address or DNS resolvable name of the host. port (`long` or `None`) – The port of the host. If None, port 443 will be used. user_name (`str`) – The administrator account on the host. password (`str`) – The password for the administrator account on the host. folder (`str` or `None`) – Host and cluster folder in which the new standalone host should be created. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. This attribute is currently required. In the future, if this attribute is None, the system will attempt to choose a suitable folder for the host; if a folder cannot be chosen, the host creation operation will fail. thumbprint_verification (`Host.CreateSpec.ThumbprintVerification`) – Type of host’s SSL certificate verification to be done. thumbprint (`str`) – The thumbprint of the SSL certificate, which the host is expected to have. The thumbprint is always computed using the SHA1 hash and is the string representation of that hash in the format: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx where, ‘x’ represents a hexadecimal digit. This attribute is optional and it is only relevant when the value of `thumbprintVerification` is `Host.CreateSpec.ThumbprintVerification.THUMBPRINT`. force_add (`bool` or `None`) – Whether host should be added to the vCenter Server even if it is being managed by another vCenter Server. The original vCenterServer loses connection to the host. If None, forceAdd is default to false.

    class `ThumbprintVerification`(string)

      Bases: `vmware.vapi.bindings.enum.Enum`

      The `Host.CreateSpec.ThumbprintVerification` class defines the thumbprint verification schemes for a host’s SSL certificate.

      Note

      This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

      Parameters: | string (`str`) – String value for the `ThumbprintVerification` instance.

      `NONE` = ThumbprintVerification(string=u'NONE')

        Accept the host’s thumbprint without verifying it.

      `THUMBPRINT` = ThumbprintVerification(string=u'THUMBPRINT')

        Host’s SSL certificate verified by checking its thumbprint against the specified thumbprint.

  class `Host.``FilterSpec`(hosts=None, names=None, folders=None, datacenters=None, standalone=None, clusters=None, connection_states=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Host.FilterSpec` class contains attributes used to filter the results when listing hosts (see `Host.list()`). If multiple attributes are specified, only hosts matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | hosts (`set` of `str` or `None`) – Identifiers of hosts that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `HostSystem`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `HostSystem`. If None or empty, hosts with any identifier match the filter. names (`set` of `str` or `None`) – Names that hosts must have to match the filter (see `Host.Summary.name`). If None or empty, hosts with any name match the filter. folders (`set` of `str` or `None`) – Folders that must contain the hosts for the hosts to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, hosts in any folder match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the hosts for the hosts to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, hosts in any datacenter match the filter. standalone (`bool` or `None`) – If true, only hosts that are not part of a cluster can match the filter, and if false, only hosts that are are part of a cluster can match the filter. If None Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and `Host.FilterSpec.clusters` os not empty, no hosts will match the filter. clusters (`set` of `str` or `None`) – Clusters that must contain the hosts for the hosts to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ClusterComputeResource`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ClusterComputeResource`. If None or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this attribute is not empty and `Host.FilterSpec.standalone` is true, no hosts will match the filter. connection_states (`set` of `Host.ConnectionState` or `None`) – Connection states that a host must be in to match the filter (see `Host.Summary.connection_state`. If None or empty, hosts in any connection state match the filter.

  class `Host.``PowerState`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `Host.PowerState` class defines the power states of a host.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `PowerState` instance.

    `POWERED_OFF` = PowerState(string=u'POWERED_OFF')

      The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.

    `POWERED_ON` = PowerState(string=u'POWERED_ON')

      The host is powered on. A host that is entering standby mode is also in this state.

    `STANDBY` = PowerState(string=u'STANDBY')

      The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.

  `Host.``RESOURCE_TYPE` = 'HostSystem'

    The resource type for the vCenter Host.

  class `Host.``Summary`(host=None, name=None, connection_state=None, power_state=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Host.Summary` class contains commonly used information about a host in vCenter Server.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | host (`str`) – Identifier of the host. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `HostSystem`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `HostSystem`. name (`str`) – Name of the host. connection_state (`Host.ConnectionState`) – Connection status of the host power_state (`Host.PowerState`) – Power state of the host This attribute is optional and it is only relevant when the value of `connectionState` is `Host.ConnectionState.CONNECTED`.

  `Host.``connect`(host)

    Connect to the host corresponding to `host` previously added to the vCenter server.

    Parameters: | host (`str`) – Identifier of the host to be reconnected. The parameter must be an identifier for the resource type: `HostSystem`.
    Raise : | `com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the host associated with `host` is already connected.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if there is no host associated with `host` in the system.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Host.``create`(spec)

    Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by `Host.CreateSpec.ThumbprintVerification`.

    Parameters: | spec (`Host.CreateSpec`) – Specification for the new host to be created.
    Return type: | `str`
    Returns: | The newly created identifier of the host in vCenter. The return value will be an identifier for the resource type: `HostSystem`.
    Raise : | `com.vmware.vapi.std.errors_client.AlreadyExists` if the host with the same name is already present.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if installation of VirtualCenter agent on a host fails.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the host name is invalid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the host folder is invalid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the SSL thumbprint specified is invalid.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidElementType` if the host folder id does not support vSphere compute resource as its children type.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInUse` if the host is already being managed by another vCenter Server
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if there are not enough licenses to add the host.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user name or password for the administration account on the host are invalid.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unsupported` if the software version on the host is not supported.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Host.``delete`(host)

    Remove a standalone host from the vCenter Server.

    Parameters: | host (`str`) – Identifier of the host to be deleted. The parameter must be an identifier for the resource type: `HostSystem`.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if there is no host associated with `host` in the system.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInUse` if the host associated with `host` is in a vCenter cluster
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Host.``disconnect`(host)

    Disconnect the host corresponding to `host` from the vCenter server

    Parameters: | host (`str`) – Identifier of the host to be disconnected. The parameter must be an identifier for the resource type: `HostSystem`.
    Raise : | `com.vmware.vapi.std.errors_client.AlreadyInDesiredState` if the host associated with `host` is already disconnected.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if there is no host associated with `host` in the system.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `Host.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) hosts in vCenter matching the `Host.FilterSpec`.

    Parameters: | filter (`Host.FilterSpec` or `None`) – Specification of matching hosts for which information should be returned. If None, the behavior is equivalent to a `Host.FilterSpec` with all attributes None which means all hosts match the filter.
    Return type: | `list` of `Host.Summary`
    Returns: | Commonly used information about the hosts matching the `Host.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `Host.FilterSpec.connection_states` attribute contains a value that is not supported by the server.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 hosts match the `Host.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``Network`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The Network class provides methods for manipulating a vCenter Server network.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FilterSpec`(networks=None, names=None, types=None, folders=None, datacenters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Network.FilterSpec` class contains attributes used to filter the results when listing networks (see `Network.list()`). If multiple attributes are specified, only networks matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | networks (`set` of `str` or `None`) – Identifiers of networks that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Network`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Network`. If None or empty, networks with any identifier match the filter. names (`set` of `str` or `None`) – Names that networks must have to match the filter (see `Network.Summary.name`). If None or empty, networks with any name match the filter. types (`set` of `Network.Type` or `None`) – Types that networks must have to match the filter (see `Network.Summary.type`). If None, networks with any type match the filter. folders (`set` of `str` or `None`) – Folders that must contain the network for the network to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, networks in any folder match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the network for the network to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, networks in any datacenter match the filter.

  `Network.``RESOURCE_TYPE` = 'Network'

    The resource type for the vCenter network

  class `Network.``Summary`(network=None, name=None, type=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `Network.Summary` class contains commonly used information about a network.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | network (`str`) – Identifier of the network. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Network`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Network`. name (`str`) – Name of the network. type (`Network.Type`) – Type (STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK) of the vCenter Server network.

  class `Network.``Type`(string)

    Bases: `vmware.vapi.bindings.enum.Enum`

    The `Network.Type` class defines the type of a vCenter Server network. The type of a network can be used to determine what features it supports and which APIs can be used to find more information about the network or change its configuration.

    Note

    This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

    Parameters: | string (`str`) – String value for the `Type` instance.

    `DISTRIBUTED_PORTGROUP` = Type(string=u'DISTRIBUTED_PORTGROUP')

      XXX: vCenter based (create and managed through vCenter)

    `OPAQUE_NETWORK` = Type(string=u'OPAQUE_NETWORK')

      A network for whose configuration is managed outside of vSphere. The identifer and name of the network is made available through vSphere so that host and virtual machine virtual ethernet devices can connect to them.

    `STANDARD_PORTGROUP` = Type(string=u'STANDARD_PORTGROUP')

      XXX: ESX based (created and managed on ESX)

  `Network.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the `Network.FilterSpec`.

    Parameters: | filter (`Network.FilterSpec` or `None`) – Specification of matching networks for which information should be returned. If None, the behavior is equivalent to a `Network.FilterSpec` with all attributes None which means all networks match the filter.
    Return type: | `list` of `Network.Summary`
    Returns: | Commonly used information about the networks matching the `Network.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `Network.FilterSpec.types` attribute contains a value that is not supported by the server.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 networks match the `Network.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``ResourcePool`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The ResourcePool class provides methods for manipulating a vCenter Server resource pool.

  This class does not include virtual appliances in the inventory of resource pools even though part of the behavior of a virtual appliance is to act like a resource pool.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `FilterSpec`(resource_pools=None, names=None, parent_resource_pools=None, datacenters=None, hosts=None, clusters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `ResourcePool.FilterSpec` class contains attributes used to filter the results when listing resource pools (see `ResourcePool.list()`). If multiple attributes are specified, only resource pools matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | resource_pools (`set` of `str` or `None`) – Identifiers of resource pools that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ResourcePool`. If None or empty, resource pools with any identifier match the filter. names (`set` of `str` or `None`) – Names that resource pools must have to match the filter (see `ResourcePool.Info.name`). If None or empty, resource pools with any name match the filter. parent_resource_pools (`set` of `str` or `None`) – Resource pools that must contain the resource pool for the resource pool to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ResourcePool`. If None or empty, resource pools in any resource pool match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the resource pool for the resource pool to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, resource pools in any datacenter match the filter. hosts (`set` of `str` or `None`) – Hosts that must contain the resource pool for the resource pool to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `HostSystem`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `HostSystem`. If None or empty, resource pools in any host match the filter. clusters (`set` of `str` or `None`) – Clusters that must contain the resource pool for the resource pool to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ClusterComputeResource`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ClusterComputeResource`. If None or empty, resource pools in any cluster match the filter.

  class `ResourcePool.``Info`(name=None, resource_pools=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `ResourcePool.Info` class contains information about a resource pool.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | name (`str`) – Name of the vCenter Server resource pool. resource_pools (`set` of `str`) – Identifiers of the child resource pools contained in this resource pool. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ResourcePool`.

  `ResourcePool.``RESOURCE_TYPE` = 'ResourcePool'

    The resource type for the vCenter resource pool

  class `ResourcePool.``Summary`(resource_pool=None, name=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `ResourcePool.Summary` class contains commonly used information about a resource pool in vCenter Server.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | resource_pool (`str`) – Identifier of the resource pool. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `ResourcePool`. name (`str`) – Name of the resource pool.

  `ResourcePool.``get`(resource_pool)

    Retrieves information about the resource pool indicated by `resource_pool`.

    Parameters: | resource_pool (`str`) – Identifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: `ResourcePool`.
    Return type: | `ResourcePool.Info`
    Returns: | information about the resource pool.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the resource pool indicated by `resource_pool` does not exist.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `ResourcePool.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the `ResourcePool.FilterSpec`.

    Parameters: | filter (`ResourcePool.FilterSpec` or `None`) – Specification of matching resource pools for which information should be returned. If None, the behavior is equivalent to a `ResourcePool.FilterSpec` with all attributes None which means all resource pools match the filter.
    Return type: | `list` of `ResourcePool.Summary`
    Returns: | Commonly used information about the resource pools matching the `ResourcePool.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 resource pools match the `ResourcePool.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

class `com.vmware.vcenter_client.``VM`(config)

  Bases: `vmware.vapi.bindings.stub.VapiInterface`

  The `VM` class provides methods for managing the lifecycle of a virtual machine.

  Parameters: | config (`vmware.vapi.bindings.stub.StubConfiguration`) – Configuration to be used for creating the stub.

  class `CreateSpec`(guest_os=None, name=None, placement=None, hardware_version=None, boot=None, boot_devices=None, cpu=None, memory=None, disks=None, nics=None, cdroms=None, floppies=None, parallel_ports=None, serial_ports=None, sata_adapters=None, scsi_adapters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    Document-based creation spec.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | guest_os (`com.vmware.vcenter.vm_client.GuestOS`) – Guest OS. name (`str` or `None`) – Virtual machine name. If None, a default name will be generated by the server. placement (`VM.PlacementSpec` or `None`) – Virtual machine placement information. This attribute is currently required. In the future, if this attribute is None, the system will attempt to choose suitable resources on which to place the virtual machine. hardware_version (`com.vmware.vcenter.vm_client.Hardware.Version` or `None`) – Virtual hardware version. If None, defaults to the most recent version supported by the server. boot (`com.vmware.vcenter.vm.hardware_client.Boot.CreateSpec` or `None`) – Boot configuration. If None, guest-specific default values will be used. boot_devices (`list` of `com.vmware.vcenter.vm.hardware.boot_client.Device.EntryCreateSpec` or `None`) – Boot device configuration. If None, a server-specific boot sequence will be used. cpu (`com.vmware.vcenter.vm.hardware_client.Cpu.UpdateSpec` or `None`) – CPU configuration. If None, guest-specific default values will be used. memory (`com.vmware.vcenter.vm.hardware_client.Memory.UpdateSpec` or `None`) – Memory configuration. If None, guest-specific default values will be used. disks (`list` of `com.vmware.vcenter.vm.hardware_client.Disk.CreateSpec` or `None`) – List of disks. If None, a single blank virtual disk of a guest-specific size will be created on the same storage as the virtual machine configuration, and will use a guest-specific host bus adapter type. If the guest-specific size is 0, no virtual disk will be created. nics (`list` of `com.vmware.vcenter.vm.hardware_client.Ethernet.CreateSpec` or `None`) – List of Ethernet adapters. If None, no Ethernet adapters will be created. cdroms (`list` of `com.vmware.vcenter.vm.hardware_client.Cdrom.CreateSpec` or `None`) – List of CD-ROMs. If None, no CD-ROM devices will be created. floppies (`list` of `com.vmware.vcenter.vm.hardware_client.Floppy.CreateSpec` or `None`) – List of floppy drives. If None, no floppy drives will be created. parallel_ports (`list` of `com.vmware.vcenter.vm.hardware_client.Parallel.CreateSpec` or `None`) – List of parallel ports. If None, no parallel ports will be created. serial_ports (`list` of `com.vmware.vcenter.vm.hardware_client.Serial.CreateSpec` or `None`) – List of serial ports. If None, no serial ports will be created. sata_adapters (`list` of `com.vmware.vcenter.vm.hardware.adapter_client.Sata.CreateSpec` or `None`) – List of SATA adapters. If None, any adapters necessary to connect the virtual machine’s storage devices will be created; this includes any devices that explicitly specify a SATA host bus adapter, as well as any devices that do not specify a host bus adapter if the guest’s preferred adapter type is SATA. scsi_adapters (`list` of `com.vmware.vcenter.vm.hardware.adapter_client.Scsi.CreateSpec` or `None`) – List of SCSI adapters. If None, any adapters necessary to connect the virtual machine’s storage devices will be created; this includes any devices that explicitly specify a SCSI host bus adapter, as well as any devices that do not specify a host bus adapter if the guest’s preferred adapter type is SCSI. The type of the SCSI adapter will be a guest-specific default type.

  class `VM.``FilterSpec`(vms=None, names=None, folders=None, datacenters=None, hosts=None, clusters=None, resource_pools=None, power_states=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `VM.FilterSpec` class contains attributes used to filter the results when listing virtual machines (see `VM.list()`). If multiple attributes are specified, only virtual machines matching all of the attributes match the filter.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | vms (`set` of `str` or `None`) – Identifiers of virtual machines that can match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `VirtualMachine`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `VirtualMachine`. If None or empty, virtual machines with any identifier match the filter. names (`set` of `str` or `None`) – Names that virtual machines must have to match the filter (see `VM.Info.name`). If None or empty, virtual machines with any name match the filter. folders (`set` of `str` or `None`) – Folders that must contain the virtual machine for the virtual machine to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Folder`. If None or empty, virtual machines in any folder match the filter. datacenters (`set` of `str` or `None`) – Datacenters that must contain the virtual machine for the virtual machine to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `Datacenter`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `Datacenter`. If None or empty, virtual machines in any datacenter match the filter. hosts (`set` of `str` or `None`) – Hosts that must contain the virtual machine for the virtual machine to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `HostSystem`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `HostSystem`. If None or empty, virtual machines on any host match the filter. clusters (`set` of `str` or `None`) – Clusters that must contain the virtual machine for the virtual machine to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ClusterComputeResource`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ClusterComputeResource`. If None or empty, virtual machines in any cluster match the filter. resource_pools (`set` of `str` or `None`) – Resource pools that must contain the virtual machine for the virtual machine to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: `ResourcePool`. If None or empty, virtual machines in any resource pool match the filter. power_states (`set` of `com.vmware.vcenter.vm_client.Power.State` or `None`) – Power states that a virtual machine must be in to match the filter (see `com.vmware.vcenter.vm_client.Power.Info.state`. If None or empty, virtual machines in any power state match the filter.

  class `VM.``Info`(guest_os=None, name=None, power_state=None, hardware=None, boot=None, boot_devices=None, cpu=None, memory=None, disks=None, nics=None, cdroms=None, floppies=None, parallel_ports=None, serial_ports=None, sata_adapters=None, scsi_adapters=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    Document-based info.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | guest_os (`com.vmware.vcenter.vm_client.GuestOS`) – Guest OS. name (`str`) – Virtual machine name. power_state (`com.vmware.vcenter.vm_client.Power.State`) – Power state of the virtual machine. hardware (`com.vmware.vcenter.vm_client.Hardware.Info`) – Virtual hardware version information. boot (`com.vmware.vcenter.vm.hardware_client.Boot.Info`) – Boot configuration. boot_devices (`list` of `com.vmware.vcenter.vm.hardware.boot_client.Device.Entry`) – Boot device configuration. If the `list` has no entries, a server-specific default boot sequence is used. cpu (`com.vmware.vcenter.vm.hardware_client.Cpu.Info`) – CPU configuration. memory (`com.vmware.vcenter.vm.hardware_client.Memory.Info`) – Memory configuration. disks (`dict` of `str` and `com.vmware.vcenter.vm.hardware_client.Disk.Info`) – List of disks. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Disk`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Disk`. nics (`dict` of `str` and `com.vmware.vcenter.vm.hardware_client.Ethernet.Info`) – List of Ethernet adapters. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Ethernet`. cdroms (`dict` of `str` and `com.vmware.vcenter.vm.hardware_client.Cdrom.Info`) – List of CD-ROMs. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Cdrom`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Cdrom`. floppies (`dict` of `str` and `com.vmware.vcenter.vm.hardware_client.Floppy.Info`) – List of floppy drives. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Floppy`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Floppy`. parallel_ports (`dict` of `str` and `com.vmware.vcenter.vm.hardware_client.Parallel.Info`) – List of parallel ports. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ParallelPort`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ParallelPort`. serial_ports (`dict` of `str` and `com.vmware.vcenter.vm.hardware_client.Serial.Info`) – List of serial ports. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SerialPort`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SerialPort`. sata_adapters (`dict` of `str` and `com.vmware.vcenter.vm.hardware.adapter_client.Sata.Info`) – List of SATA adapters. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SataAdapter`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.SataAdapter`. scsi_adapters (`dict` of `str` and `com.vmware.vcenter.vm.hardware.adapter_client.Scsi.Info`) – List of SCSI adapters. When clients pass a value of this class as a parameter, the key in the attribute `dict` must be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ScsiAdapter`. When methods return a value of this class as a return value, the key in the attribute `dict` will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.ScsiAdapter`.

  class `VM.``PlacementSpec`(folder=None, resource_pool=None, host=None, cluster=None, datastore=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `VM.PlacementSpec` class contains information used to place a virtual machine onto resources within the vCenter inventory.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | folder (`str` or `None`) – Virtual machine folder into which the virtual machine should be placed. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Folder`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Folder`. This attribute is currently required. In the future, if this attribute is None, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine creation operation will fail. resource_pool (`str` or `None`) – Resource pool into which the virtual machine should be placed. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `ResourcePool`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `ResourcePool`. This attribute is currently required if both `host` and `cluster` are None. In the future, if this attribute is None, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine creation operation will fail. host (`str` or `None`) – Host onto which the virtual machine should be placed. If `host` and `resourcePool` are both specified, `resourcePool` must belong to `host`. If `host` and `cluster` are both specified, `host` must be a member of `cluster`. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `HostSystem`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `HostSystem`. This attribute may be None if `resourcePool` or `cluster` is specified. If None, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine creation operation will fail. cluster (`str` or `None`) – Cluster onto which the virtual machine should be placed. If `cluster` and `resourcePool` are both specified, `resourcePool` must belong to `cluster`. If `cluster` and `host` are both specified, `host` must be a member of `cluster`. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `ClusterComputeResource`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `ClusterComputeResource`. If `resourcePool` or `host` is specified, it is recommended that this attribute be None. datastore (`str` or `None`) – Datastore on which the virtual machine’s configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine creation operation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `Datastore`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `Datastore`. This attribute is currently required. In the future, if this attribute is None, the system will attempt to choose suitable storage for the virtual machine; if storage cannot be chosen, the virtual machine creation operation will fail.

  class `VM.``Summary`(vm=None, name=None, power_state=None, cpu_count=None, memory_size_mib=None)

    Bases: `vmware.vapi.bindings.struct.VapiStruct`

    The `VM.Summary` class contains commonly used information about a virtual machine.

    Tip

    The arguments are used to initialize data attributes with the same names.

    Parameters: | vm (`str`) – Identifier of the virtual machine. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: `VirtualMachine`. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: `VirtualMachine`. name (`str`) – Name of the Virtual machine. power_state (`com.vmware.vcenter.vm_client.Power.State`) – Power state of the virtual machine. cpu_count (`long` or `None`) – Number of CPU cores. This attribute will be None if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation. memory_size_mib (`long` or `None`) – Memory size in mebibytes. This attribute will be None if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

  `VM.``create`(spec)

    Creates a virtual machine.

    Parameters: | spec (`VM.CreateSpec`) – Virtual machine specification.
    Return type: | `str`
    Returns: | ID of newly-created virtual machine. The return value will be an identifier for the resource type: `VirtualMachine`.
    Raise : | `com.vmware.vapi.std.errors_client.AlreadyExists` if a virtual machine with the specified name already exists.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if any of the specified parameters are invalid.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if any of the resources specified in spec could not be found
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if a specified resource (eg. host) is not accessible.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInUse` if any of the specified storage addresses (eg. IDE, SATA, SCSI) result in a storage address conflict.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if any of the resources needed to create the virtual machine could not be allocated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.
    Raise : | `com.vmware.vapi.std.errors_client.Unsupported` if `guestOS` is not supported for the requested virtual hardware version and spec includes None attributes that default to guest-specific values.

  `VM.``delete`(vm)

    Deletes a virtual machine.

    Parameters: | vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceBusy` if the virtual machine is busy performing another operation.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if the virtual machine’s configuration state cannot be accessed.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `VM.``get`(vm)

    Returns information about a virtual machine.

    Parameters: | vm (`str`) – Virtual machine identifier. The parameter must be an identifier for the resource type: `VirtualMachine`.
    Return type: | `VM.Info`
    Returns: | Information about the specified virtual machine.
    Raise : | `com.vmware.vapi.std.errors_client.Error` if the system reports an error while responding to the request.
    Raise : | `com.vmware.vapi.std.errors_client.NotFound` if the virtual machine is not found.
    Raise : | `com.vmware.vapi.std.errors_client.ResourceInaccessible` if the virtual machine’s configuration state cannot be accessed.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

  `VM.``list`(filter=None)

    Returns information about at most 1000 visible (subject to permission checks) virtual machines in vCenter matching the `VM.FilterSpec`.

    Parameters: | filter (`VM.FilterSpec` or `None`) – Specification of matching virtual machines for which information should be returned. If None, the behavior is equivalent to a `VM.FilterSpec` with all attributes None which means all virtual machines match the filter.
    Return type: | `list` of `VM.Summary`
    Returns: | Commonly used information about the virtual machines matching the `VM.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.InvalidArgument` if the `VM.FilterSpec.power_states` attribute contains a value that is not supported by the server.
    Raise : | `com.vmware.vapi.std.errors_client.UnableToAllocateResource` if more than 1000 virtual machines match the `VM.FilterSpec`.
    Raise : | `com.vmware.vapi.std.errors_client.ServiceUnavailable` if the system is unable to communicate with a service to complete the request.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthenticated` if the user can not be authenticated.
    Raise : | `com.vmware.vapi.std.errors_client.Unauthorized` if the user doesn’t have the required privileges.

## Subpackages

- appliance Package
  - `appliance` Package
  - `access_client` Module
  - `health_client` Module
  - `networking_client` Module
  - `recovery_client` Module
  - `system_client` Module
  - `techpreview_client` Module
  - `vmon_client` Module
  - Subpackages
    - networking Package
      - `networking` Package
      - `dns_client` Module
    - recovery Package
      - `recovery` Package
      - `backup_client` Module
      - `restore_client` Module
    - techpreview Package
      - `techpreview` Package
      - `localaccounts_client` Module
      - `monitoring_client` Module
      - `networking_client` Module
      - `ntp_client` Module
      - `services_client` Module
      - `system_client` Module
      - Subpackages
        - networking Package
          - `networking` Package
          - Subpackages
            - firewall Package
              - `firewall` Package
              - `addr_client` Module
- cis Package
  - `cis` Package
  - `tagging_client` Module
- content Package
  - `content` Package
  - `library_client` Module
  - Subpackages
    - library Package
      - `library` Package
      - `item_client` Module
      - Subpackages
        - item Package
          - `item` Package
          - `downloadsession_client` Module
          - `updatesession_client` Module
- vapi Package
  - `vapi` Package
  - `metadata_client` Module
  - `std_client` Module
  - `vcenter_client` Module
  - Subpackages
    - metadata Package
      - `metadata` Package
      - `authentication_client` Module
      - `cli_client` Module
      - `metamodel_client` Module
      - `privilege_client` Module
      - `routing_client` Module
      - Subpackages
        - authentication Package
          - `authentication` Package
          - `service_client` Module
        - metamodel Package
          - `metamodel` Package
          - `resource_client` Module
          - `service_client` Module
        - privilege Package
          - `privilege` Package
          - `service_client` Module
        - routing Package
          - `routing` Package
          - `service_client` Module
    - std Package
      - `std` Package
      - `activation_client` Module
      - `errors_client` Module
      - `interposition_client` Module
      - `introspection_client` Module
- vcenter Package
  - `vcenter` Package
  - `inventory_client` Module
  - `iso_client` Module
  - `ovf_client` Module
  - `vm_client` Module
  - Subpackages
    - vm Package
      - `vm` Package
      - `hardware_client` Module
      - Subpackages
        - hardware Package
          - `hardware` Package
          - `adapter_client` Module
          - `boot_client` Module

### Navigation

- index
- modules |
- next |
- previous |
- vSphere Automation SDK for Python 6.5.0 documentation »
- com Package »