com.vmware.esx.hosts package

Submodules

com.vmware.esx.hosts.software_client module

The com.vmware.esx.hosts.software_client module provides classes to get information about current software on ESX.

class com.vmware.esx.hosts.software_client.InstalledComponents(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

The InstalledComponents class provides methods to get installed list of components.

Parameters

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

class InstalledComponentInfo(display_name=None, version=None, display_version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The InstalledComponents.InstalledComponentInfo class contains attributes that describe the installed component on the host.

Tip

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

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

  • version (str) – Version of the installed component

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

class ProductLine(string)

Bases: vmware.vapi.bindings.enum.Enum

The InstalledComponents.ProductLine class defines product line. Product line are used to specify the platform vib is built for.

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

EMBEDDED_ESX = ProductLine(string='EMBEDDED_ESX')
ESX_IO = ProductLine(string='ESX_IO')
list(host)

Returns the installed components on the host.

Parameters

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

Return type

dict of str and InstalledComponents.InstalledComponentInfo

Returns

The components installed on the host. The key in the return value dict will be an identifier for the resource type: com.vmware.esx.hosts.component.

Raise

com.vmware.vapi.std.errors_client.InternalServerError 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.NotFound If there is no host associated with host 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 HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

class com.vmware.esx.hosts.software_client.StubFactory(stub_config)

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters

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