com.vmware.esx.settings package

Subpackages

Submodules

com.vmware.esx.settings.clusters_client module

The com.vmware.esx.settings.clusters_client module provides classes to manage desired state configuration and software for a cluster of ESX hosts.

class com.vmware.esx.settings.clusters_client.DepotOverrides(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The DepotOverrides class provides methods to manage software depots overriden for a given cluster. In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX clusters can’t (or because of bandwidth requirements shouldn’t) reach out to vCenter to fetch payloads and metadata. This class allows setting cluster level overrides for depots. If any depots are provided for a cluster, then vCenter level depots are not used for that cluster’s remediation. These are not synced periodically at vCenter and are only used by ESXs for lifecycle operations.

Parameters

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

class Depot(location=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The DepotOverrides.Depot class defines the information regarding a particular depot override for a given cluster.

Tip

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

Parameters

location (str) – Location of the depot override. This could be a location of zip file or location to an index.xml file.

class Info(depots=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The DepotOverrides.Info class defines the information regarding depot overrides for a given cluster.

Tip

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

Parameters

depots (list of DepotOverrides.Depot) – List of the depot overrides.

add(cluster, depot)

Adds a new depot override to the list of currently configured depot overrides for a given cluster.

Parameters
  • cluster (str) – Identifier for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • depot (DepotOverrides.Depot) – Information of a depot override.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If an invalid location is provided.

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.AlreadyExists if depot override with given information already exists.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

get(cluster)

Returns the information about currently configured depot overrides for a given cluster.

Parameters

cluster (str) – Identifier for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Return type

DepotOverrides.Info

Returns

Information about currently configured depot overrides for a given cluster.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

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 service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

remove(cluster, depot)

Removes a depot override from the list of currently configured depot overrides for a given cluster.

Parameters
  • cluster (str) – Identifier for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • depot (DepotOverrides.Depot) – Information of the depot override to be removed.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no depot override with given information or no cluster associated with identifier {param.name cluster} in the system.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

class com.vmware.esx.settings.clusters_client.Software(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Software class provides methods to manage desired software specification of an ESX cluster.

Parameters

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

class ApplyResult(status=None, commit=None, host_info=None, host_status=None, successful_hosts=None, failed_hosts=None, skipped_hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.ApplyResult class contains attributes that describe the result of an Software.apply() method.

Tip

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

Parameters
  • status (Software.ApplyStatus or None) – Specifies the aggregated status of the Software.apply() method. None if the Software.apply() method is in progress.

  • commit (str) – The identifier of the commit used to fetch the desired software document to be applied to all hosts within the cluster. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit.

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information of the hosts in this cluster to which the desired software document specified by the Software.ApplyResult.commit should be applied to. 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: HostSystem. 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: HostSystem.

  • host_status (dict of str and Software.ApplyStatus) – Status of the hosts in this cluster to which the desired software document specified by the Software.ApplyResult.commit was applied to. Hosts on which the Software.apply() method was successful are specified by Software.ApplyResult.successful_hosts. Hosts on which the apply method failed are specified by Software.ApplyResult.failed_hosts. Hosts which were skipped by the Software.apply() method are specified by Software.ApplyResult.skipped_hosts. 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: HostSystem. 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: HostSystem.

  • successful_hosts (set of str) – Hosts in this cluster to which the desired software document specified by the Software.ApplyResult.commit has been successfully applied to. 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.

  • failed_hosts (set of str) – Hosts in this cluster to which the desired software document specified by the Software.ApplyResult.commit failed to be applied to. 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.

  • skipped_hosts (set of str) – Hosts in this cluster that were skipped by the Software.apply() method. 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.

class ApplySpec(commit=None, hosts=None, accept_eula=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.ApplySpec class contains attributes that describe the specification to be used for applying the desired software document to a cluster.

Tip

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

Parameters
  • commit (str or None) – The minimum commit identifier of the desired software document to be used during the Software.apply() method. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit. if None or empty the apply method will use the latest commit to fetch the desired state document.

  • hosts (set of str or None) – The specific hosts within the cluster to be considered during the Software.apply() method. 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 the Software.apply() method will remediate all hosts within the cluster.

  • accept_eula (bool or None) – Accept the VMware End User License Agreement (EULA) before starting the Software.apply() method. The VMware EULA is available for download at, https://www.vmware.com/download/eula.html if None the Software.apply() method could fail due to the EULA not being accepted.

class ApplyStatus(status=None, progress=None, start_time=None, end_time=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.ApplyStatus class contains attributes that describe the status of an Software.apply() method.

Tip

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

Parameters
class Status(string)

Bases: vmware.vapi.bindings.enum.Enum

The Software.ApplyStatus.Status class contains the possible different status codes that can be returned while trying to Software.apply() the desired software specification to hosts within the cluster.

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.

ERROR = Status(string='ERROR')

The method encountered an unspecified error.

OK = Status(string='OK')

The method completed successfully.

RUNNING = Status(string='RUNNING')

The method is in progress. This class attribute was added in vSphere API 7.0.1.0.

SKIPPED = Status(string='SKIPPED')

The method was skipped.

TIMED_OUT = Status(string='TIMED_OUT')

The method timed out.

class CheckInfo(check=None, name=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.CheckInfo class contains attributes that describe a particular check.

Tip

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

Parameters
class CheckResult(status=None, start_time=None, end_time=None, commit=None, host_info=None, entity_results=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.CheckResult class contains attributes that describe aggregated status of all checks performed.

Tip

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

Parameters
  • status (Software.Status) – Aggregated status from all checks performed.

  • start_time (datetime.datetime) – Time when the operation started.

  • end_time (datetime.datetime) – Time when the operation completed.

  • commit (str) – The identifier of the commit on which checks have been run. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit.

  • host_info (dict of str and com.vmware.esx.settings_client.HostInfo) – Information about the hosts in this cluster for which checks have been requested to be run. 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: HostSystem. 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: HostSystem.

  • entity_results (list of Software.EntityCheckResult) – List of Software.EntityCheckResult for all entities for which checks have been run.

class CheckSpec(commit=None, hosts=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.CheckSpec class contains attributes that describe the specification to be used for running checks on the cluster before the Software.apply() method.

Tip

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

Parameters
  • commit (str or None) – The minimum commit identifier of the desired software document to be used during the check method. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.commit. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.commit. if None or empty the check opertion will use the latest commit to fetch the desired state document.

  • hosts (set of str or None) – The specific hosts for which checks need to be performed 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 checks are run for all hosts within the cluster.

class CheckStatus(check=None, status=None, issues=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.CheckStatus class contains attributes that describe a check result.

Tip

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

Parameters
class EntityCheckResult(type=None, cluster=None, host=None, status=None, check_statuses=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.EntityCheckResult class contains attributes that describe aggregated status of all checks performed on a specific entity.

Tip

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

Parameters
  • type (Software.EntityCheckResult.EntityType) – The entity type for which these checks are being run.

  • cluster (str) – If the entity type is CLUSTER then the cluster identifier for which the checks have been run. 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. This attribute is optional and it is only relevant when the value of type is Software.EntityCheckResult.EntityType.CLUSTER.

  • host (str) – If the entity type is HOST then the host identifier for which the checks have been run. 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 is optional and it is only relevant when the value of type is Software.EntityCheckResult.EntityType.HOST.

  • status (Software.Status) – Aggregated status from all checks performed on this entity.

  • check_statuses (list of Software.CheckStatus) – List of Software.CheckStatus for all checks performed.

class EntityType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Software.EntityCheckResult.EntityType class contains the entitites on which checks can be performed.

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 EntityType instance.

CLUSTER = EntityType(string='CLUSTER')

Entity type Cluster

HOST = EntityType(string='HOST')

Entity type Host

class ExportSpec(export_software_spec=None, export_iso_image=None, export_offline_bundle=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.ExportSpec class contains information describing how a software specification or image should be exported.

Tip

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

Parameters
  • export_software_spec (bool) – Whether to export software specification document.

  • export_iso_image (bool) – Whether to export ISO image.

  • export_offline_bundle (bool) – Whether to export offline bundle.

class ExportType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Software.ExportType class defines the formats in which software specification document or image can be exported.

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 ExportType instance.

ISO_IMAGE = ExportType(string='ISO_IMAGE')

Export ISO image.

OFFLINE_BUNDLE = ExportType(string='OFFLINE_BUNDLE')

Export offline bundle.

SOFTWARE_SPEC = ExportType(string='SOFTWARE_SPEC')

Export software specification document.

class Status(string)

Bases: vmware.vapi.bindings.enum.Enum

The Software.Status class defines the status result for a particular check.

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.

ERROR = Status(string='ERROR')

The check indicates an error.

OK = Status(string='OK')

The check indicates a success.

TIMEOUT = Status(string='TIMEOUT')

The check did not return in a timely manner.

WARNING = Status(string='WARNING')

The check indicates a warning.

apply_task(cluster, spec)

Applies the desired software document associated with the given cluster to hosts within the cluster. If commit attribute is set, it implies the minimum commit that the Software.apply() method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Parameters
  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • spec (Software.ApplySpec) – Apply specification.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.AlreadyInDesiredState If the cluster is already at specified commit as described in the apply specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the commit attribute of spec specifies an invalid commit, or the hosts attribute of spec specifies an invalid host or a host not part of the cluster, or the cluster is not managed with a single software specification.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState If there is another operation in progress.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or if desired software document is not found.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.TimedOut If the operation times out.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

check_task(cluster, spec)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If commit attribute is set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Parameters
  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • spec (Software.CheckSpec) – Check specification.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If the commit attribute of spec specifies an invalid commit, or the hosts attribute of spec specifies an invalid host or a host not part of the cluster.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState If there is another operation in progress or if the commit attribute of spec specifies a commit that has already been applied.

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 service is not available.

Raise

com.vmware.vapi.std.errors_client.TimedOut If the operation times out.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

export(cluster, spec)

Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.

Parameters
  • cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

  • spec (Software.ExportSpec) –

Return type

dict of Software.ExportType and str

Returns

A map from export type to URL of the exported data for that type.

Raise

com.vmware.vapi.std.errors_client.Error If there is am unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or if desired software document is not found.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get(cluster)

Returns the complete desired software specification.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Return type

com.vmware.esx.settings_client.SoftwareInfo

Returns

Cluster software specification.

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

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 service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.

  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

scan_task(cluster)

Scans all the hosts in the cluster against the cluster’s desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Parameters

cluster (str) – Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no cluster associated with cluster in the system or if desired software document is not found.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

class com.vmware.esx.settings.clusters_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.esx.settings.defaults_client module

The com.vmware.esx.settings.defaults_client module provides classes to manage defaults that affect management of desired state configuration and software for ESXi clusters and hosts.

class com.vmware.esx.settings.defaults_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.esx.settings.depot_content_client module

The com.vmware.esx.settings.depot_content_client module provides classes to retrieve contents from the depot.

class com.vmware.esx.settings.depot_content_client.AddOns(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The AddOns class provides methods to get OEM add-ons from the sync’ed and imported depots.

Parameters

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

class AddOnVersionSummary(version=None, display_version=None, summary=None, category=None, kb=None, release_date=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOns.AddOnVersionSummary class defines the summary information regarding a version of an OEM add-on.

Tip

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

Parameters
  • version (str) – Version of the OEM add-on.

  • display_version (str) – Human readable version of the OEM add-on.

  • summary (str) – Summary of the OEM add-on version.

  • category (AddOns.CategoryType) – Category of the OEM add-on version.

  • kb (str) – Link to kb article related to this the OEM add-on version.

  • release_date (datetime.datetime) – Release date of the OEM add-on version.

class CategoryType(string)

Bases: vmware.vapi.bindings.enum.Enum

The AddOns.CategoryType class defines possible values of categories for a OEM add-on.

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 CategoryType instance.

BUGFIX = CategoryType(string='BUGFIX')

Bugfix

ENHANCEMENT = CategoryType(string='ENHANCEMENT')

Enhancement

SECURITY = CategoryType(string='SECURITY')

Security

class FilterSpec(vendors=None, names=None, versions=None, min_version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOns.FilterSpec class contains attributes used to filter the results when listing OEM add-ons, see AddOns.list()).

Tip

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

Parameters
  • vendors (set of str or None) – Vendors that an add-on must have to match the filter. If None or empty, add-ons from any vendor will match the filter.

  • names (set of str or None) – Names that an add-on must have to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.esx.settings.add_on. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.esx.settings.add_on. If None or empty, add-ons with any name will match the filter.

  • versions (set of str or None) – Versions that an add-on must have to match the filter. If None or empty, add-ons with any version will match the filter.

  • min_version (str or None) – Minimum version of an add-on that can match the filter. If set, only OEM add-ons with version greater than or equal to this will be returned.

RESOURCE_TYPE = 'com.vmware.esx.settings.add_on'

Resource type for add-on resource

class Summary(name=None, display_name=None, vendor=None, versions=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOns.Summary class defines the summary information regarding a OEM add-on.

Tip

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

Parameters
  • name (str) – Name of the OEM add-on. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.add_on. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.add_on.

  • display_name (str) – Display name of the OEM add-on.

  • vendor (str) – Vendor of the OEM add-on.

  • versions (list of AddOns.AddOnVersionSummary) – Summary information about the versions of this addon. These are sorted by the version.

list(filter=None)

Returns a list of currently available OEM add-ons in the depot.

Parameters

filter (AddOns.FilterSpec or None) – The specification of matching OEM add-ons. If None, the behavior is equivalent to a AddOns.FilterSpec with all attributes None, which means all OEM add-ons match the filter.

Return type

list of AddOns.Summary

Returns

List of OEM add-ons in the depot.

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depot_content_client.BaseImages(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The BaseImages class provides methods to get base-images from the sync’ed and imported depots.

Parameters

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

class CategoryType(string)

Bases: vmware.vapi.bindings.enum.Enum

The BaseImages.CategoryType class defines possible values of categories for a base-image.

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 CategoryType instance.

BUGFIX = CategoryType(string='BUGFIX')

Bugfix

ENHANCEMENT = CategoryType(string='ENHANCEMENT')

Enhancement

SECURITY = CategoryType(string='SECURITY')

Security

class FilterSpec(min_version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImages.FilterSpec class contains attributes used to filter the results when listing base-images, see BaseImages.list()).

Tip

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

Parameters

min_version (str or None) – Minimum version of a base-image that can match the filter. If set, only base-images with version greater than or equal to this version will be returned.

RESOURCE_TYPE = 'com.vmware.esx.settings.base_image'

Resource type for add-on resource

class Summary(display_name=None, version=None, display_version=None, summary=None, category=None, kb=None, release_date=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImages.Summary class defines the summary information regarding a base-image.

Tip

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

Parameters
  • display_name (str) – Display name of the base-image.

  • version (str) – Version of the base-image. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.base_image. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.base_image.

  • display_version (str) – Human readable version of the base-image.

  • summary (str) – Summary of the base-image.

  • category (BaseImages.CategoryType) – Category of the base-image.

  • kb (str) – Link to kb article related to this the base-image.

  • release_date (datetime.datetime) – Release date of the base-image.

list(filter=None)

Returns a list of currently available base-images in the depot.

Parameters

filter (BaseImages.FilterSpec or None) – The specification of matching base-images. If None, the behavior is equivalent to a BaseImages.FilterSpec with all attributes None, which means all base-images match the filter.

Return type

list of BaseImages.Summary

Returns

List of base-images in the depot. These will be sorted by the version of the base-image.

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depot_content_client.Components(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Components class provides methods to get Components from the sync’ed and imported depots.

Parameters

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

class CategoryType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Components.CategoryType class defines possible values of categories for a component.

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 CategoryType instance.

BUGFIX = CategoryType(string='BUGFIX')

Bugfix

ENHANCEMENT = CategoryType(string='ENHANCEMENT')

Enhancement

GENERAL = CategoryType(string='GENERAL')

General

INFO = CategoryType(string='INFO')

Info

MISC = CategoryType(string='MISC')

Misc

RECALL = CategoryType(string='RECALL')

Recall

RECALL_FIX = CategoryType(string='RECALL_FIX')

Recall-fix

SECURITY = CategoryType(string='SECURITY')

Security

class ComponentBundleType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Components.ComponentBundleType class defines possible ways components are bundled.

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 ComponentBundleType instance.

ADD_ON = ComponentBundleType(string='ADD_ON')

Components bundled in add-ons

BASE_IMAGE = ComponentBundleType(string='BASE_IMAGE')

Components bundled in base-images

INDEPENDENT = ComponentBundleType(string='INDEPENDENT')

Components not bundled in base-images or add-ons

class ComponentVersionSummary(version=None, display_version=None, summary=None, category=None, urgency=None, kb=None, release_date=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Components.ComponentVersionSummary class defines the summary information regarding a version of a component.

Tip

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

Parameters
  • version (str) – Version of the component.

  • display_version (str) – Human readable version of the component.

  • summary (str) – Summary of the component version.

  • category (Components.CategoryType) – Category of the component version.

  • urgency (Components.UrgencyType) – Urgency of the component version.

  • kb (str) – Link to kb article related to this the component version.

  • release_date (datetime.datetime) – Release date of the component version.

class FilterSpec(vendors=None, names=None, versions=None, min_version=None, bundle_types=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Components.FilterSpec class contains attributes used to filter the results when listing components, see Components.list()).

Tip

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

Parameters
  • vendors (set of str or None) – Vendors that a component must have to match the filter. If None or empty, components with any vendor name match the filter.

  • names (set of str or None) – Names that a component must have to match the filter. When clients pass a value of this class as a parameter, the attribute must contain identifiers for the resource type: com.vmware.esx.settings.component. When methods return a value of this class as a return value, the attribute will contain identifiers for the resource type: com.vmware.esx.settings.component. If None or empty, components with any name will match the filter.

  • versions (set of str or None) – Versions that a component must have to match the filter. If None or empty, components with any version will match the filter.

  • min_version (str or None) – Minimum version of the component that can match the filter. If set, only components with version greater than or equal to the given version match the filter.

  • bundle_types (set of Components.ComponentBundleType or None) – Component bundle types that a component must have to match the filter. If None or empty, all components will match the filter.

RESOURCE_TYPE = 'com.vmware.esx.settings.component'

Resource type for add-on resource

class Summary(name=None, display_name=None, vendor=None, versions=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Components.Summary class defines the summary information regarding a component.

Tip

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

Parameters
  • name (str) – Name of the Component. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.component. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.component.

  • display_name (str) – Display name of the component.

  • vendor (str) – Vendor of the component.

  • versions (list of Components.ComponentVersionSummary) – Summary information about the versions of this component. These are sorted by the version.

class UrgencyType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Components.UrgencyType class defines possible values of urgencies for a component.

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 UrgencyType instance.

CRITICAL = UrgencyType(string='CRITICAL')

Critical

GENERAL = UrgencyType(string='GENERAL')

General

IMPORTANT = UrgencyType(string='IMPORTANT')

Important

LOW = UrgencyType(string='LOW')

Low

MODERATE = UrgencyType(string='MODERATE')

Moderate

list(filter=None)

Returns a list of currently available components in the depot.

Parameters

filter (Components.FilterSpec or None) – The specification of matching components. If None, the behavior is equivalent to a Components.FilterSpec with all attributes None, which means ALL components match the filter.

Return type

list of Components.Summary

Returns

List of components in the depot.

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depot_content_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.esx.settings.depots_client module

The com.vmware.esx.settings.depots_client module provides classes to manage VUM compatible ESX Depots.

class com.vmware.esx.settings.depots_client.Offline(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Offline class provides methods to manage Offline Software Depots used during ESX lifecycle management.

Parameters

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

class CreateResult(depot=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Offline.CreateResult class defines the result information for a new Offline Depot.

Tip

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

Parameters

depot (str) – ID of the Offline Depot. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.settings.depots.offline. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

class CreateSpec(description=None, source_type=None, location=None, file_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Offline.CreateSpec class defines the information used to create a depot.

Tip

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

Parameters
  • description (str or None) – Description of the depot. If None, the description will be empty.

  • source_type (Offline.SourceType) – Type of the source from which offline bundle is obtained.

  • location (str) – Location of the depot from which content should be retrieved. This attribute is optional and it is only relevant when the value of sourceType is Offline.SourceType.PULL.

  • file_id (str) – File identifier returned by the file upload endpoint after file is uploaded. This attribute is optional and it is only relevant when the value of sourceType is Offline.SourceType.PUSH.

class Info(description=None, source_type=None, location=None, file_id=None, create_time=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Offline.Info class defines the information regarding an Offline Depot.

Tip

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

Parameters
  • description (str) – Description of the Depot. If not set during import, it will be empty.

  • source_type (Offline.SourceType) – Type of the source from which Offline Depot is obtained.

  • location (str) – Location of the depot from which content is retrieved. This attribute is optional and it is only relevant when the value of sourceType is Offline.SourceType.PULL.

  • file_id (str) – File identifier returned by the file upload endpoint after file is uploaded. This attribute is optional and it is only relevant when the value of sourceType is Offline.SourceType.PUSH.

  • create_time (datetime.datetime) – Time when the depot was created.

RESOURCE_TYPE = 'com.vmware.esx.settings.depots.offline'

Resource type for depots resource

class SourceType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Offline.SourceType class defines possible values of sources for the offline depot.

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 SourceType instance.

PULL = SourceType(string='PULL')

Content is pulled from the URL location. The URL scheme of the value in {\@link #pullLocation) can be http, https or file.

PUSH = SourceType(string='PUSH')

Content was previously uploaded using the file upload enpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.

class Summary(description=None, source_type=None, location=None, file_id=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Offline.Summary class defines the summary information regarding an Offline Depot.

Tip

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

Parameters
  • description (str) – Description of the Depot. If not set during import, it will be empty.

  • source_type (Offline.SourceType) – Type of the source from which Offline Depot is obtained.

  • location (str) – Location of the depot from which content is retrieved. This attribute is optional and it is only relevant when the value of sourceType is Offline.SourceType.PULL.

  • file_id (str) – File identifier returned by the file upload endpoint after file is uploaded. This attribute is optional and it is only relevant when the value of sourceType is Offline.SourceType.PUSH.

create_task(spec)

Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Parameters

spec (Offline.CreateSpec) – Depot specification to import an offline depot.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If an invalid pullLocation is provided.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists If the depot content of CreateSpec already exists. The value of the data attribute of com.vmware.vapi.std.errors_client.Error will be a class that contains existing depot content id as part of depot attribute defined in Offline.CreateResult.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

delete(depot)

Removes a depot from the list of imported offline software depots.

Parameters

depot (str) – Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no depot associated with parameter depot in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

get(depot)

Gets the information about an imported offline software depot.

Parameters

depot (str) – Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Return type

Offline.Info

Returns

Information about the imported offline software depot.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no depot with given identifier depot in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

list()

Returns currently imported offline software depots.

Return type

dict of str and Offline.Summary

Returns

Map of currently imported offline software depots keyed by their identifier. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.depots_client.Online(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Online class provides methods to manage Online Software Depots used during ESX lifecycle management.

Parameters

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

class CreateSpec(description=None, location=None, enabled=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Online.CreateSpec class defines the information used to create a depot.

Tip

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

Parameters
  • description (str or None) – Description of the Depot. If None, the description will be empty.

  • location (str) – Location of the Depot. It should be the location to the index.xml for that depot.

  • enabled (bool or None) – Flag indicating whether this depot is enabled or not. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If None the depot will be enabled.

class Info(description=None, location=None, enabled=None, system_defined=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Online.Info class defines the information regarding a Depot.

Tip

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

Parameters
  • description (str) – Description of the Depot. It will be an empty string if no description was provided during create.

  • location (str) – Location of the Depot.

  • enabled (bool) – Flag indicating whether this depot is enabled or not.

  • system_defined (bool) – Flag to indicate if the depot is system defined. System defined depot can not be deleted.

RESOURCE_TYPE = 'com.vmware.esx.settings.depots.online'

Resource type for depots resource

class Summary(description=None, location=None, enabled=None, system_defined=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Online.Summary class defines the summary information regarding a Depot.

Tip

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

Parameters
  • description (str) – Description of the Depot. It will be an empty string if no description was provided during create.

  • location (str) – Location of the Depot.

  • enabled (bool) – Flag indicating whether this depot is enabled or not.

  • system_defined (bool) – Flag to indicate if the depot is system defined. System defined depot can not be deleted.

class UpdateSpec(enabled=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Online.UpdateSpec class defines the information used to update the depot.

Tip

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

Parameters
  • enabled (bool or None) – Flag indicating whether this depot is enabled or not. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If None, enabled flag is not updated.

  • description (str or None) – Description of the Depot. If None, description is not updated.

create(spec)

Adds a new online software depot to the list of currently configured online software depots.

Parameters

spec (Online.CreateSpec) – Depot information.

Return type

str

Returns

Identifier of the currently configured online software depot. The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If an invalid location is provided.

Raise

com.vmware.vapi.std.errors_client.AlreadyExists if depot with given location already exists.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

delete(depot)

Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that depot.

Parameters

depot (str) – Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If given depot is system defined.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no depot associated with depot in the system.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

get(depot)

Gets the information about a currently configured online software depot.

Parameters

depot (str) – Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Return type

Online.Info

Returns

Information of the currently configured online software depot.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no depot with given identifier depot in the system.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

list()

Returns a list of currently configured online software depots.

Return type

dict of str and Online.Summary

Returns

Map of currently configured online software depots keyed by their identifiers. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.settings.depots.online.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

update(depot, spec)

Updates the configuration of a currently configured online software depot.

Parameters
  • depot (str) – Identifier of the depot to be updated. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.

  • spec (Online.UpdateSpec) – Update specification.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If given depot is system defined.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no depot associated with parameter depot in the system.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

class com.vmware.esx.settings.depots_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.esx.settings.depots_client.SyncSchedule(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The SyncSchedule class provides methods to manage Schedule of Online Software Depot sync.

Parameters

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

class DayOfWeek(string)

Bases: vmware.vapi.bindings.enum.Enum

The SyncSchedule.DayOfWeek class contains the supported days of the week.

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 DayOfWeek instance.

FRIDAY = DayOfWeek(string='FRIDAY')

Friday.

MONDAY = DayOfWeek(string='MONDAY')

Monday.

SATURDAY = DayOfWeek(string='SATURDAY')

Saturday.

SUNDAY = DayOfWeek(string='SUNDAY')

Sunday.

THURSDAY = DayOfWeek(string='THURSDAY')

Thursday.

TUESDAY = DayOfWeek(string='TUESDAY')

Tuesday.

WEDNESDAY = DayOfWeek(string='WEDNESDAY')

Wednesday.

class Recurrence(string)

Bases: vmware.vapi.bindings.enum.Enum

The SyncSchedule.Recurrence class contains the supported values for how often to sync from online or UMDS depots.

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 Recurrence instance.

DAILY = Recurrence(string='DAILY')

Daily.

HOURLY = Recurrence(string='HOURLY')

Hourly.

MONTHLY_BY_DAY = Recurrence(string='MONTHLY_BY_DAY')

Monthly by day.

WEEKLY = Recurrence(string='WEEKLY')

Weekly.

class Schedule(type=None, skip=None, minute=None, hour=None, day_of_month=None, day_of_week=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SyncSchedule.Schedule class defines a schedule.

Tip

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

Parameters
class Spec(enabled=None, schedule=None, email_addresses=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SyncSchedule.Spec class defines the information regarding the sync schedule.

Tip

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

Parameters
  • enabled (bool) – Flag indicating whether automatic sync is enabled or not

  • schedule (SyncSchedule.Schedule or None) – The schedule to check for new updates. If None the schedule must be disabled.

  • email_addresses (list of str) – Email addresses to which the notification will be sent. If empty, no notification is sent.

get()

Returns the currently configured software depot sync schedule.

Return type

SyncSchedule.Spec

Returns

Currently configured sync schedule.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

set(spec=None)

Sets the software depot sync schedule.

Parameters

spec (SyncSchedule.Spec or None) – Information of the software depot sync schedule. If None, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If SyncSchedule.Spec.schedule is unset while SyncSchedule.Spec.enabled is set to true or if any of the values is not within valid range.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

class com.vmware.esx.settings.depots_client.Umds(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Umds class provides methods to manage VMware vSphere Update Manager Download Service (UMDS) software depots used during ESX lifecycle management. This is the depot downloaded using UMDS.

If a UMDS depot is specified then online depots are ignored and data is downloaded only from the UMDS depot.

Parameters

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

class Info(description=None, enabled=None, location=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Umds.Info class defines the information regarding an UMDS Depot.

Tip

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

Parameters
  • description (str) – Description of the Depot. It will be an empty string if no description was provided during create.

  • enabled (bool) – Flag indicating whether or not this depot is enabled.

  • location (str) – Location of the Depot.

class SetSpec(description=None, enabled=None, location=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Umds.SetSpec class defines the information of an UMDS depot.

Tip

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

Parameters
  • description (str or None) – Description of the Depot. If None, the description will be empty.

  • enabled (bool or None) – Flag indicating whether or not this depot should be enabled. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If None the depot will be enabled.

  • location (str) – Location of the Depot. It should be the location to the index.xml for that depot.

class UpdateSpec(enabled=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Umds.UpdateSpec class defines the information used to update the UMDS depot.

Tip

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

Parameters
  • enabled (bool or None) – Flag indicating whether or not this depot is enabled. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If None, the enabled flag is not updated.

  • description (str or None) – Description of the Depot. If None, the description is not updated.

delete()

Removes the configured UMDS software depot. It will not remove the downloaded metadata and payloads from that depot.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no UMDS software depot set.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

get()

Gets the information about a currently configured UMDS software depot.

Return type

Umds.Info

Returns

Information of the currently configured UMDS software depot.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no UMDS software depot set.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

set(spec)

Sets or overwrites information about an UMDS software depot.

Parameters

spec (Umds.SetSpec) –

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument If an invalid location is provided.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

update(spec)

Updates the configuration of a currently configured UMDS software depot.

Parameters

spec (Umds.UpdateSpec) – Update specification.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no UMDS depot configured.

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Write.

com.vmware.esx.settings.hardware_support_client module

class com.vmware.esx.settings.hardware_support_client.Managers(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Managers class provides methods to list Hardware Support Manager (HSM) for a given vCenter.

Parameters

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

class HardwareSupportManagerInfo(manager=None, description=None, display_name=None, vendor=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Managers.HardwareSupportManagerInfo class contains attributes that describe a particular 3rd party Hardware Support Manager (HSM)

Tip

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

Parameters
  • manager (str) – Name of the Hardware Support Manager (HSM) (e.g. “Frobozz Hardware Support Manager”) When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.

  • description (str) – User-intelligible description of the HSM (e.g. “Front end for Frobozz so-and-so management system”)

  • display_name (str) – UI label for HSM, derived from HSM extension’s description’s ‘label’ field. (e.g. “Frobozz Free Management System”)

  • vendor (str) – Company providing the Hardware Support Manager (HSM) (e.g. “Frobozz Magic Software Company”)

list()

Returns the list of registered Hardware Support Managers (HSMs) in the system.

Return type

list of Managers.HardwareSupportManagerInfo

Returns

List of currently registered Hardware Support Manager (HSMs)

Raise

com.vmware.vapi.std.errors_client.Error If there is some unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unauthorized if you do not have all of the privileges described as follows:

  • Method execution requires VcIntegrity.lifecycleSettings.Read.

class com.vmware.esx.settings.hardware_support_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.esx.settings.hosts_client module

The com.vmware.esx.settings.hosts_client module provides classes to manage desired state configuration and software for a standalone ESX host.

class com.vmware.esx.settings.hosts_client.Software(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The Software class provides methods to manage desired software specification of a standalone ESX host.

Parameters

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

scan_task(host)

Scans the host against the host’s desired state.. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Parameters

host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

Return type

class

vmware.vapi.stdlib.client.task.Task

Returns

Task instance

Raise

com.vmware.vapi.std.errors_client.Error If there is unknown internal error. The accompanying error message will give more details about the failure.

Raise

com.vmware.vapi.std.errors_client.NotFound If there is no host associated with host in the system or if desired software document is not found.

Raise

com.vmware.vapi.std.errors_client.ServiceUnavailable If the service is not available.

Raise

com.vmware.vapi.std.errors_client.Unauthenticated If the caller is not authenticated.

Raise

com.vmware.vapi.std.errors_client.Unsupported If the host is not a standlone host, but instead part of a cluster.

class com.vmware.esx.settings.hosts_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance