com.vmware.esx package

Subpackages

Submodules

com.vmware.esx.hcl_client module

The com.vmware.esx.hcl_client module provides classes to query the hardware compatibility for an ESXi or a cluster.

class com.vmware.esx.hcl_client.CompatibilityData(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

This class provides methods to update the local compatibility data residing on the vCenter Appliance or to get information about the said data. The information in the data is generic VMware compatibility information for servers and devices.

Parameters

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

class Status(updated_at=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The CompatibilityData.Status class contains attributes to describe the information available for the compatibility data.

Tip

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

Parameters

  • updated_at (datetime.datetime) – Indicates when the data was last updated.

  • notifications (Notifications) – Notifications returned by the operation.

get()

Provides information about the compatibility data located on the vCenter Appliance.

Return type

CompatibilityData.Status

Returns

Information about the compatibility data.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if there is no compatibility data on the vCenter executing the operation.

Raise

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

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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.HardwareCompatibility.Read.

update_task()

Replaces the local compatibility data with the latest version found from VMware official source.

Raise

com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if there is compatibility data update in progress.

Raise

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

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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.

class com.vmware.esx.hcl_client.CompatibilityStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

The CompatibilityStatus class defines compatibility status of a given server or PCI device against a specific release of ESXi.

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

CERTIFIED = CompatibilityStatus(string='CERTIFIED')

When given hardware is certified for the specified ESXi release. Its software is also validated and it is also certified.

COMPATIBLE = CompatibilityStatus(string='COMPATIBLE')

When given hardware is certified for the specified ESXi release but no validation of the software of this hardware is performed.

INCOMPATIBLE = CompatibilityStatus(string='INCOMPATIBLE')

When given hardware is not certified for the specified ESXi release.

NOT_CERTIFIED = CompatibilityStatus(string='NOT_CERTIFIED')

When given hardware is certified for the specified ESXi release. Its software is also validated and it is not certified.

UNAVAILABLE = CompatibilityStatus(string='UNAVAILABLE')

When there is no information about specified hardware.

class com.vmware.esx.hcl_client.Driver(name=None, version=None, vendor=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Driver class contains attributes describing information about a driver.

Tip

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

Parameters

  • name (str) – The name of the driver.

  • version (str) – The version of the driver.

  • vendor (str or None) – The vendor that produced the driver. If None vendor is unknown.

class com.vmware.esx.hcl_client.Firmware(version=None, vendor=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Firmware class contains attributes describing information about a firmware.

Tip

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

Parameters

  • version (str) – The version of the firmware.

  • vendor (str or None) – The vendor that produced the firmware. If None vendor is unknown.

class com.vmware.esx.hcl_client.Notification(id=None, time=None, message=None, resolution=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notification class contains attributes to describe any info/warning/error messages that Tasks can raise.

Tip

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

Parameters
class com.vmware.esx.hcl_client.Notifications(info=None, warnings=None, errors=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notifications class contains info/warning/error messages that can be reported be the task.

Tip

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

Parameters

  • info (list of Notification or None) – Info notification messages reported. Only set if an info was reported by the task.

  • warnings (list of Notification or None) – Warning notification messages reported. Only set if an warning was reported by the task.

  • errors (list of Notification or None) – Error notification messages reported. Only set if an error was reported by the task.

class com.vmware.esx.hcl_client.PCIDevice(pci_address=None, vid=None, did=None, svid=None, ssid=None, vendor=None, model_name=None, class_code=None, sub_class_code=None, driver=None, firmware=None, used_by_vsan=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The PCIDevice class contains attributes describing information about a single PCI device on a host.

Tip

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

Parameters

  • pci_address (str) – The device’s address in a given ESXi host.

  • vid (str) – A unique number assigned to each computer hardware device that helps to identify the chipset manufacturer. For example, Dell, Broadcom, etc.

  • did (str) – A unique number that identifies the specific device of the Vendor (VID).

  • svid (str) – A unique number that identifies the card manufacturer.

  • ssid (str) – A unique number that identifies the specific device of Subsystem Vendor (SVID).

  • vendor (str) – The name of the vendor.

  • model_name (str) – The name of the device model.

  • class_code (str) – Register that specifies the type of function the device performs.

  • sub_class_code (str) – Register that specifies the specific function the device performs.

  • driver (Driver) – Currently installed driver used by the device.

  • firmware (Firmware or None) – Currently installed firmware used by the device. If None firmware is unknown.

  • used_by_vsan (bool) – Shows whether the device is part of VSAN cluster or not.

class com.vmware.esx.hcl_client.Reports(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

This class provides methods to download information generated from the hardware compatibility feature residing on the vCenter Appliance.

Parameters

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

class Location(url=None, report_token=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Reports.Location class contains the URI location to download generated compatibility report, as well as a token required (as a header on the HTTP GET request) to get the report. The validity of the token is 5 minutes. After the token expires, any attempt to call the URI with said token will fail.

Tip

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

Parameters

  • url (str) – Compatibility report download URL.

  • report_token (Reports.Token) – Information about the token required in the HTTP GET request to download the compatibility report.

class Token(token=None, expiry=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Reports.Token class contains information about the token required to be passed in the HTTP header in the HTTP GET request to generate the report.

Tip

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

Parameters

  • token (str) – A one-time, short-lived token required in the HTTP header of the request to the url. This token needs to be passed in as a header with the name “session-id”.

  • expiry (datetime.datetime) – Expiry time of the token

get(report)

Returns the location Reports.Location information for downloading a compatibility report.

Parameters

report (str) – identifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport.

Return type

Reports.Location

Returns

Reports.Location class which includes the URI to file, short lived token and expiry of the token in the Reports.Location object.

Raise

com.vmware.vapi.std.errors_client.NotFound if there is no report for the given id.

Raise

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

Raise

com.vmware.vapi.std.errors_client.ResourceInaccessible if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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.HardwareCompatibility.Read.

class com.vmware.esx.hcl_client.Server(model_name=None, vendor=None, cpu_series=None, cpu_features=None, bios=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Server class contains attributes describing information about a server.

Tip

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

Parameters

  • model_name (str) – The name of the server model (for example, “PowerEdge R740xd”).

  • vendor (str) – The name of the vendor (for example, “Dell”).

  • cpu_series (str) –

    The CPU series name (for example, “Intel Xeon Gold 6100/5100, Silver 4100, Bronze 3100 (Skylake-SP) Series”).

    Note: This attribute is initialized with the CPU model name; it’s updated to the actual CPU series later, based on recognizing one of the CPU series the server hardware is certified with in the VCG.s

  • cpu_features (str) – The current CPU features.

  • bios (Firmware) – Currently installed BIOS of the server.

class com.vmware.esx.hcl_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.hosts_client module

The com.vmware.esx.hosts_client module provides classes to manage ESX host.

class com.vmware.esx.hosts_client.AddOnInfo(name=None, version=None, display_name=None, vendor=None, display_version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOnInfo class contains attributes that describe a specific OEM customization add-on in the software solution.

Tip

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

Parameters

  • name (str) – Name of the 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.hosts.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.hosts.add_on.

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

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

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

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

class com.vmware.esx.hosts_client.AddOnSpec(name=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOnSpec class contains attributes that describe a specific OEM customization add-on in the software specification. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • name (str) – Name of the add-on. This attribute was added in vSphere API 7.0.2.0.

  • version (str) – Version of the add-on. This attribute was added in vSphere API 7.0.2.0.

class com.vmware.esx.hosts_client.BaseImageInfo(version=None, display_name=None, display_version=None, release_date=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImageInfo class contains attributes that describe a specific ESX base-image in the software solution.

Tip

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

Parameters

  • 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.hosts.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.hosts.base_image.

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

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

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

class com.vmware.esx.hosts_client.BaseImageSpec(version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImageSpec class contains attributes that describe a specific ESX base-image in the software specification. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

version (str) – Version of the base-image. This attribute was added in vSphere API 7.0.2.0.

class com.vmware.esx.hosts_client.CertificateInfo(ssl_thumbprint=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The CertificateInfo Class contains information about the SSL certificate for a server. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

ssl_thumbprint (str) – The SHA thumbprint of the SSL certificate for a server. This attribute was added in vSphere API 7.0.2.0.

class com.vmware.esx.hosts_client.ComponentInfo(version=None, display_name=None, display_version=None, vendor=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ComponentInfo class contains attributes that describe a specific component version in the software solution.

Tip

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

Parameters

  • version (str) – Version of the component.

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

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

  • vendor (str) – Vendor of the component.

class com.vmware.esx.hosts_client.HardwareSupportInfo(packages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportInfo class contains information to describe the Hardware Support Package (HSP) in the software solution. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

packages (dict of str and HardwareSupportPackageInfo) – Map of Hardware Support Packages (HSPs). The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM. This attribute was added in vSphere API 7.0.2.0. 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.esx.hosts.hardware_support.manager. 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.esx.hosts.hardware_support.manager.

class com.vmware.esx.hosts_client.HardwareSupportPackageInfo(pkg=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportPackageInfo class contains information to describe the Hardware Support Package (HSP) configured for a single device or distinct group of devices (typically the OEM’s, including BIOS and device firmware). This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • pkg (str) – Identifier of Hardware Support Package (HSP) selected. This attribute was added in vSphere API 7.0.2.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.hosts.hardware_support.package. 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.hosts.hardware_support.package.

  • version (str) – Version of the Hardware Support Package (HSP) selected (e.g. “20180128.1” or “v42”). This attribute was added in vSphere API 7.0.2.0.

class com.vmware.esx.hosts_client.HardwareSupportPackageSpec(pkg=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportPackageSpec class contains attributes to describe the Hardware Support Package (HSP) configured for a single device or distinct group of devices (typically the OEM’s, including BIOS, device firmware and OEM-supplied driver or agent components). This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • pkg (str or None) – Hardware Support Package (HSP) selected. This attribute was added in vSphere API 7.0.2.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.hosts.hardware_support.package. 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.hosts.hardware_support.package.

  • version (str or None) – Version of the Hardware Support Package (HSP) selected (e.g. “20180128.1” or “v42”). This attribute was added in vSphere API 7.0.2.0. If None, the system will use an empty string as the version.

class com.vmware.esx.hosts_client.HardwareSupportSpec(packages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportSpec class contains attributes to describe the Hardware Support Packages (HSP) included in the software specification. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

packages (dict of str and HardwareSupportPackageSpec) – Map of Hardware Support Packages (HSPs). The key is the Hardware Support Manager (HSM) name and the value is the specification detailing the HSP configured for that HSM. This attribute was added in vSphere API 7.0.2.0. 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.esx.hosts.hardware_support.manager. 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.esx.hosts.hardware_support.manager.

class com.vmware.esx.hosts_client.Notification(id=None, time=None, message=None, resolution=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notification class contains attributes to describe any info/warning/error messages that Tasks can raise. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • id (str) – The notification id. This attribute was added in vSphere API 7.0.2.0.

  • time (datetime.datetime) – The time the notification was raised/found. This attribute was added in vSphere API 7.0.2.0.

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message. This attribute was added in vSphere API 7.0.2.0.

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. This attribute was added in vSphere API 7.0.2.0. Only set if there is a resolution available for this notification.

class com.vmware.esx.hosts_client.Notifications(info=None, warnings=None, errors=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notifications class contains info/warning/error messages that can be reported be the task. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • info (list of Notification or None) – Info notification messages reported. This attribute was added in vSphere API 7.0.2.0. Only set if an info was reported by the task.

  • warnings (list of Notification or None) – Warning notification messages reported. This attribute was added in vSphere API 7.0.2.0. Only set if an warning was reported by the task.

  • errors (list of Notification or None) – Error notification messages reported. This attribute was added in vSphere API 7.0.2.0. Only set if an error was reported by the task.

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

Bases: vmware.vapi.bindings.stub.VapiInterface

The Software class provides methods to get and extract the current software specification applied to the host. This class was added in vSphere API 7.0.2.0.

Parameters

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

class ConnectionSpec(auth_type=None, host_credential=None, host=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.ConnectionSpec class contains attributes that describe the specification to be used for connecting to the host during the Software.get() method. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • auth_type (Software.ConnectionSpec.AuthenticationType) – Specifies what type of authentication (USERNAME_PASSWORD, EXISTING) is to be used when connecting with the host. USERNAME_PASSWORD is intended to be used when connecting to a host that is not currently part of the vCenter inventory. EXISTING is intented for hosts that are in vCenter inventory, in which case, HostServiceTicket will be used to connect to the host. This attribute was added in vSphere API 7.0.2.0.

  • host_credential (Software.HostCredentials) – Specifies the host details to be used during the Software.get() method. This attribute was added in vSphere API 7.0.2.0. This attribute is optional and it is only relevant when the value of authType is Software.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD.

  • host (str) – Specifies the host Managed Object ID to be used during the Software.get() method. This attribute was added in vSphere API 7.0.2.0. 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 authType is Software.ConnectionSpec.AuthenticationType.EXISTING.

class AuthenticationType(string)

Bases: vmware.vapi.bindings.enum.Enum

The Software.ConnectionSpec.AuthenticationType class defines the possible types of authentication supported when connecting to the host. This enumeration was added in vSphere API 7.0.2.0.

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

EXISTING = AuthenticationType(string='EXISTING')

Connect to the host using service ticket. Note: This is supported only for hosts present in the VC inventory. This class attribute was added in vSphere API 7.0.2.0.

USERNAME_PASSWORD = AuthenticationType(string='USERNAME_PASSWORD')

Connect to host using host’s credentials HostCredentials class. This class attribute was added in vSphere API 7.0.2.0.

class HostCredentials(host_name=None, user_name=None, password=None, port=None, ssl_thumb_print=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.HostCredentials class contains attributes that describe the host’s username, password, port number and ssl thumbprint to be used when connecting to the host using USERNAME_PASSWORD option in the AuthenticationType class. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • host_name (str) – The IP address or DNS resolvable name of the host. This attribute was added in vSphere API 7.0.2.0.

  • user_name (str) – Specifies the username to be used during the Software.get() method. This attribute was added in vSphere API 7.0.2.0.

  • password (str) – Specifies the password to be used during the Software.get() method. This attribute was added in vSphere API 7.0.2.0.

  • port (long or None) – Specifies the port number of the host to be used during Software.get() method. This attribute was added in vSphere API 7.0.2.0. If None, port number is set to 443.

  • ssl_thumb_print (str or None) – Specifies the sslThumbPrint of the host to be used during Software.get() method SHA1 hash of the host’s SSL certificate. This attribute was added in vSphere API 7.0.2.0. If None, Software.get() method throws UnverifiedPeer with the expected thumbprint as data.

class Info(notifications=None, software_info=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Software.Info class contains attributes that describe the current software information on a host. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • notifications (Notifications) – Notifications returned by the get operation. This attribute was added in vSphere API 7.0.2.0.

  • software_info (SoftwareInfo) – Host software information returned by the get operation. This attribute was added in vSphere API 7.0.2.0.

get(spec)

Returns details about the current software specification applied to the host. This method was added in vSphere API 7.0.2.0.

Parameters

spec (Software.ConnectionSpec) – ConnectionSpec connection spec for the host.

Return type

Software.Info

Returns

Info details about the current software specification applied to the host.

Raise

com.vmware.vapi.std.errors_client.InvalidArgument if the ConnectionSpec.HostCredentials#hostName attribute of spec is invalid.

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.NotFound If there is no ConnectionSpec.HostCredentials#hostName attribute associated with host id 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.UnverifiedPeer If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in ConnectionSpec.HostCredentials#sslThumbPrint.

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.

class com.vmware.esx.hosts_client.SoftwareInfo(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SoftwareInfo class contains attributes that describes the software solution for an ESX host.

Tip

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

Parameters

  • base_image (BaseImageInfo) – Base image of the ESX.

  • add_on (AddOnInfo or None) – OEM customization on top of given base-image. The components in this customization override the components in the base base-image. If None, no OEM customization exists.

  • components (dict of str and (ComponentInfo or None)) – Map of components in an ESX image. The key is the component name and value is the information about specific version of the component. 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.esx.hosts.component. 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.esx.hosts.component.

  • solutions (dict of str and SolutionInfo) – Map of software solutions in an ESX image. The key is the solution name and value is the specification detailing components registered by that solution. 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.esx.hosts.solution. 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.esx.hosts.solution.

  • hardware_support (HardwareSupportInfo or None) – Information about the Hardware Support Packages (HSP) configured. This attribute was added in vSphere API 7.0.2.0. If None, no Hardware Support Package (HSP) info exists.

class com.vmware.esx.hosts_client.SoftwareSpec(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SoftwareSpec class contains attributes that describe software specification for an ESX host. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • base_image (BaseImageSpec) – Base image of the ESX. This attribute was added in vSphere API 7.0.2.0.

  • add_on (AddOnSpec or None) – OEM customization on top of given base-image. The components in this customization override the components in the base base-image. This attribute was added in vSphere API 7.0.2.0. If None, no OEM customization will be applied.

  • components ((dict of str and (str or None)) or None) – Additional components which are part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in SoftwareSpec.add_on and SoftwareSpec.base_image. This attribute was added in vSphere API 7.0.2.0. 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.esx.hosts.component. 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.esx.hosts.component. If None, no additional components are present in the software specification.

  • solutions ((dict of str and SolutionSpec) or None) – Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution. This attribute was added in vSphere API 7.0.2.0. 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.esx.hosts.solution. 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.esx.hosts.solution. If None, no solutions are present in the software specification.

  • hardware_support (HardwareSupportSpec or None) – Information about the Hardware Support Package (HSP) configured in the software specification. This attribute was added in vSphere API 7.0.2.0. If None or empty, no firmware info will be part of the software specification.

class com.vmware.esx.hosts_client.SolutionComponentSpec(component=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionComponentSpec class contains attributes that describe a component registered by a software solution. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

component (str) – Identifier of the component. This attribute was added in vSphere API 7.0.2.0. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.esx.hosts.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.hosts.component.

class com.vmware.esx.hosts_client.SolutionInfo(version=None, display_name=None, components=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionInfo class contains attributes that describe solution registered in the software solution.

Tip

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

Parameters

  • version (str) – Version of the solution.

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

  • components (dict of str and ComponentInfo) – Components registered by the solution. 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.esx.hosts.component. 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.esx.hosts.component.

class com.vmware.esx.hosts_client.SolutionSpec(version=None, components=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionSpec class contains attributes that describe solution registered in the software specification. This class was added in vSphere API 7.0.2.0.

Tip

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

Parameters

  • version (str) – Version of the solution. This attribute was added in vSphere API 7.0.2.0.

  • components (list of SolutionComponentSpec) – Components registered by the solution. This attribute was added in vSphere API 7.0.2.0.

class com.vmware.esx.hosts_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_client module

The com.vmware.esx.settings_client module provides classes to manage ESX settings.

class com.vmware.esx.settings_client.AddOnCompliance(status=None, current=None, target=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOnCompliance class contains information that describe the compliance of the OEM add-on with respect to the add-on present in the target software specification.

Tip

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

Parameters

  • status (ComplianceStatus) – Compliance status of the OEM add-on.

  • current (AddOnInfo or None) – Current OEM add-on present on the host. None if OEM add-on is not present on the host.

  • target (AddOnInfo or None) – Target OEM add-on present in the software specification. None if OEM add-on is not present in the software specification.

  • notifications (Notifications) – Notifications describing the compliance result.

class com.vmware.esx.settings_client.AddOnDetails(display_name=None, vendor=None, display_version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOnDetails class contains information that provide more details about the add-on from the depot.

Tip

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

Parameters

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

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

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

class com.vmware.esx.settings_client.AddOnInfo(details=None, name=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOnInfo class contains information that describe a specific OEM customization add-on.

Tip

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

Parameters

  • details (AddOnDetails or None) – Details about the add-on. None if add-on is not present in the depot.

  • name (str) – Name of the add-on

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

class com.vmware.esx.settings_client.AddOnSpec(name=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The AddOnSpec class contains attributes that describe a specific OEM customization add-on.

Tip

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

Parameters

  • name (str) – Name of the add-on

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

class com.vmware.esx.settings_client.BaseImageCompliance(status=None, current=None, target=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImageCompliance class contains information that describe the compliance of ESX base image with respect to the base image present in the target software specification.

Tip

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

Parameters

  • status (ComplianceStatus) – Compliance status of the base image.

  • current (BaseImageInfo) – Current base image information on the host.

  • target (BaseImageInfo) – Target base image information present in the software specification.

  • notifications (Notifications) – Notifications describing the compliance result.

class com.vmware.esx.settings_client.BaseImageDetails(display_name=None, display_version=None, release_date=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImageDetails class contains information that provide more details about the base image from the depot.

Tip

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

Parameters

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

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

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

class com.vmware.esx.settings_client.BaseImageInfo(details=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImageInfo class contains information that describe a specific ESX base-image.

Tip

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

Parameters

  • details (BaseImageDetails or None) – Details about the base-image. None if base-image is not present in the depot.

  • version (str) – Version of the base-image

class com.vmware.esx.settings_client.BaseImageSpec(version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The BaseImageSpec class contains attributes that describe a specific ESX base-image.

Tip

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

Parameters

version (str) – Version of the base-image

class com.vmware.esx.settings_client.CheckDescription(check=None, name=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The CheckDescription class contains attributes that describe a particular check.

Tip

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

Parameters
class com.vmware.esx.settings_client.CheckError(description=None, resolution=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The CheckError class contains attributes that describe an error reported by CheckStatus

Tip

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

Parameters

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of what was the issue containing as much user-relevant context as possible. The user should be able to understand which sub-system failed and why.

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – Possible resolution for the issue. This should contain actionable information that the user can use to resolve the issue. Can be left None if no meaningful resolution exists.

class com.vmware.esx.settings_client.CheckStatus(check=None, status=None, originator=None, errors=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The CheckStatus class contains attributes that describe a check result.

Tip

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

Parameters

  • check (CheckDescription) – Information about this check.

  • status (Status) – The status of this check.

  • originator (str or None) – The service that performed the check. This field should allow easier triaging of health query errors. Only set if there is an originator available for this check.

  • errors (list of CheckError or None) – List of CheckError that the check reported. If not set, the service is still using the {#member issues}. TODO

class com.vmware.esx.settings_client.ClusterCompliance(impact=None, status=None, notifications=None, scan_time=None, commit=None, compliant_hosts=None, non_compliant_hosts=None, incompatible_hosts=None, unavailable_hosts=None, hosts=None, host_info=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ClusterCompliance class contains attributes to describe the compliance result of a cluster.

Tip

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

Parameters

  • impact (ComplianceImpact) – Overall impact.

  • status (ComplianceStatus) – Overall compliance status of the cluster.

  • notifications (Notifications) – Notifications returned by the scan operation.

  • scan_time (datetime.datetime) – Scan completion time.

  • commit (str or None) – Identifier of the commit on which the scan is run to generate this result. 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. None if operation is performed on a draft.

  • compliant_hosts (set of str) – Identifiers of compliant hosts. 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.

  • non_compliant_hosts (set of str) – Identifiers of non-compliant hosts. 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.

  • incompatible_hosts (set of str) – Identifiers of incompatible hosts. 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.

  • unavailable_hosts (set of str) – Identifiers of unavailable hosts. There will not be compliance details for these hosts in ClusterCompliance.hosts. 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.

  • hosts (dict of str and HostCompliance) – Mapping from host identifier to the compliance information for the host. 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_info (dict of str and HostInfo) – Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result. 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.

class com.vmware.esx.settings_client.ComplianceImpact(string)

Bases: vmware.vapi.bindings.enum.Enum

The ComplianceImpact class contains information about the impact of applying the target state in case of non compliance.

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

MAINTENANCE_MODE_REQUIRED = ComplianceImpact(string='MAINTENANCE_MODE_REQUIRED')

Host requires maintenance mode to reach this target state.

NO_IMPACT = ComplianceImpact(string='NO_IMPACT')

Host has no impact.

PARTIAL_MAINTENANCE_MODE_REQUIRED = ComplianceImpact(string='PARTIAL_MAINTENANCE_MODE_REQUIRED')

Host requires partial maintenance mode to reach this target state.

REBOOT_REQUIRED = ComplianceImpact(string='REBOOT_REQUIRED')

Host requires reboot to reach this target state.

UNKNOWN = ComplianceImpact(string='UNKNOWN')

Impact is unknown.

class com.vmware.esx.settings_client.ComplianceStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

The ComplianceStatus class contains the possible different status of compliance with respect to target version.

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

COMPLIANT = ComplianceStatus(string='COMPLIANT')

Target version is same as current version.

INCOMPATIBLE = ComplianceStatus(string='INCOMPATIBLE')

Target state cannot be applied due to conflict or missing dependencies or the target state is lesser than the current version.

NON_COMPLIANT = ComplianceStatus(string='NON_COMPLIANT')

Target version is greater than current version.

UNAVAILABLE = ComplianceStatus(string='UNAVAILABLE')

Drift check failed due to unknown error or check hasn’t happened yet and results are not available.

class com.vmware.esx.settings_client.ComponentCompliance(status=None, current=None, target=None, current_source=None, target_source=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ComponentCompliance class contains information that describe the compliance of a component with respect to the component present in the target software specification.

Tip

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

Parameters

  • status (ComplianceStatus) – Compliance status of the component.

  • current (ComponentInfo or None) – Current version of the component present on the host. None if component is not present on the host.

  • target (ComponentInfo or None) – Target version of the component present in the software specification. None if component is not present in the software specification.

  • current_source (ComponentSource or None) – Source of the component on the host. None if component is not present on the host.

  • target_source (ComponentSource or None) – Source of the component in the software specification. None if component is not present in the software specification.

  • notifications (Notifications) – Notifications describing the compliance result.

class com.vmware.esx.settings_client.ComponentDetails(display_name=None, vendor=None, display_version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ComponentDetails class contains information that provide more details about the component from the depot.

Tip

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

Parameters

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

  • vendor (str) – Vendor of the component.

  • display_version (str or None) – Human readable version of the component. None if no version is provided for the component.

class com.vmware.esx.settings_client.ComponentInfo(version=None, details=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ComponentInfo class contains information that describe a specific component version in a software specification.

Tip

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

Parameters

  • version (str or None) – Version of the component. None if version is not specified.

  • details (ComponentDetails or None) – Details about the component. None if component is not present in the depot.

class com.vmware.esx.settings_client.ComponentOverrideInfo(version=None, display_version=None, source=None, note=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The ComponentOverrideInfo class contains fields that describe how the component was overridden.

Tip

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

Parameters
class com.vmware.esx.settings_client.ComponentSource(string)

Bases: vmware.vapi.bindings.enum.Enum

The ComponentSource class contains the component’s source information.

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

ADD_ON = ComponentSource(string='ADD_ON')

Addon is the source for this component

BASE_IMAGE = ComponentSource(string='BASE_IMAGE')

Base image is the source for this component

HARDWARE_SUPPORT_PACKAGE = ComponentSource(string='HARDWARE_SUPPORT_PACKAGE')

Hardware Support Package (HSP) is the source for this component

SOLUTION = ComponentSource(string='SOLUTION')

Solution is the source for this component

USER = ComponentSource(string='USER')

User is the source for this component

class com.vmware.esx.settings_client.Depots(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

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

Parameters

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

sync_task()

Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. 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.

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.TimedOut if the service is timed out.

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.

class com.vmware.esx.settings_client.EffectiveComponentDetails(display_name=None, display_version=None, vendor=None, source=None, note=None, overridden_components=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The EffectiveComponentDetails class contains information that provide more details about the component from the depot.

Tip

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

Parameters

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

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

  • vendor (str) – Vendor of the component.

  • source (ComponentSource) – Final effective source of the component.

  • note (com.vmware.vapi.std_client.LocalizableMessage or None) – Note assosicated with this component. If None, note is present for this component.

  • overridden_components (list of ComponentOverrideInfo) – List of other component versions present in base-image, add-ons or solutions that this component is overriding. For example, if a component version-1 was implicitly present in the base-image, but user wants it to be changed to version-2. In that case, EffectiveComponentDetails.source would be USER and there will be one entry in this list indicating base-image component version-1 is being overridden.

class com.vmware.esx.settings_client.EffectiveComponentInfo(version=None, details=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The EffectiveComponentInfo class contains information that describe a component and how that component appeared in the software specification.

Tip

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

Parameters

  • version (str) – Version of the component.

  • details (EffectiveComponentDetails or None) – Details about the effective component. None if component is not present in the depot.

class com.vmware.esx.settings_client.HardwareModuleClass(string)

Bases: vmware.vapi.bindings.enum.Enum

The HardwareModuleClass class contains the module’s source information.

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

OTHER = HardwareModuleClass(string='OTHER')

Other (non-PCI) hardware

PCI_DEVICE = HardwareModuleClass(string='PCI_DEVICE')

PCI device

SYSTEM_BIOS = HardwareModuleClass(string='SYSTEM_BIOS')

System BIOS

class com.vmware.esx.settings_client.HardwareModuleDetails(component_class=None, description=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareModuleDetails class contains information that provide more details about the a hardware module (e.g. BIOS, PCI device).

Tip

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

Parameters

  • component_class (HardwareModuleClass) – Class of module (BIOS, PCI Device, non-PCI hardware, etc.)

  • description (str or None) – Descipription of the hardware module (e.g. “System BIOS” or “Frobozz 100Gb NIC”). None if description is not specified.

class com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance(status=None, details=None, current=None, target=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareModuleFirmwareCompliance class contains information that describe the compliance of firmware of a particular hardware module (e.g. BIOS, PCI device) on the host with respect to the firmware present in the target Hardware Support Package (HSP) specification.

Tip

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

Parameters

  • status (ComplianceStatus) – Compliance status of the hardware module’s firmware.

  • details (HardwareModuleDetails or None) – Additional details about the hardware module itself None if no further info was provided by HSM.

  • current (HardwareModuleFirmwareInfo or None) – Current version of the firmware present on the host hardware module. None if version of firmware on the hardware module on the host cannot be determined.

  • target (HardwareModuleFirmwareInfo or None) – Target version of the firmware present in the Hardware Support Package (HSP). None if component is not present in the software specification.

  • notifications (Notifications) – Notifications describing the compliance result.

class com.vmware.esx.settings_client.HardwareModuleFirmwareInfo(version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareModuleFirmwareInfo class contains information to describe the firmware on a hardware component or module (e.g. BIOS, PCI device).

Tip

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

Parameters

version (str) – Version of the hardware module firmware.

class com.vmware.esx.settings_client.HardwareSupportInfo(packages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportInfo class contains information to describe the desired Hardware Support Package (HSP) configured for a cluster.

Tip

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

Parameters

packages (dict of str and HardwareSupportPackageInfo) – Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) identifier and the value is the specification detailing the HSP configured for that HSM. 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.esx.setting.hardware_support.manager. 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.esx.setting.hardware_support.manager.

class com.vmware.esx.settings_client.HardwareSupportPackageCompliance(status=None, current=None, target=None, hardware_modules=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportPackageCompliance class contains information that describe compliance of the Hardware Support Package (HSP) on the host with respect to the Hardware support Package (HSP) present in the target software image specification, if any.

Tip

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

Parameters

  • status (ComplianceStatus) – Compliance status of the Hardware Support Package (HSP).

  • current (HardwareSupportPackageInfo or None) – Current version of the Hardware Support Package present on the host. None if there is no known Hardware Support Package on the host.

  • target (HardwareSupportPackageInfo or None) – Target version of the Hardware Support Package present in the software specification. None if current desired image includes a Hardware Support Manager (HSM) but no target Hardware Support Package (HSP).

  • hardware_modules (dict of str and HardwareModuleFirmwareCompliance) – Compliance result for individual hardware module on the host. The key is the module identifier and value is the HardwareModuleFirmwareCompliance for the device. NOTE: if no individual hardware module compliance is returned by the, Hardware Support Manager (HSM), this map may have no entries even if ComplianceStatus = NON_COMPLIANT 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.esx.setting.hardware_module. 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.esx.setting.hardware_module.

  • notifications (Notifications) – Notifications describing the compliance result.

class com.vmware.esx.settings_client.HardwareSupportPackageInfo(pkg=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportPackageInfo class contains information to describe the desired Hardware Support Package (HSP) configured for a single device or distinct group of devices (typically the OEM’s, including BIOS and device firmware).

Tip

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

Parameters

  • pkg (str) – Identifier of Hardware Support Package (HSP) selected 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.package. 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.package.

  • version (str) – Version of the Hardware Support Package (HSP) selected (e.g. “20180128.1” or “v42”)

class com.vmware.esx.settings_client.HardwareSupportPackageSpec(pkg=None, version=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportPackageSpec class contains attributes to describe the desired Hardware Support Package (HSP) configured for a single device or distinct group of devices (typically the OEM’s, including BIOS, device firmware and OEM-supplied driver or agent components).

Tip

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

Parameters

  • pkg (str or None) – Hardware Support Package (HSP) selected 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.package. 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.package.

  • version (str or None) – Version of the Hardware Support Package (HSP) selected (e.g. “20180128.1” or “v42”) If None, the system will use an empty string as the version.

class com.vmware.esx.settings_client.HardwareSupportSpec(packages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HardwareSupportSpec class contains attributes to describe the desired Hardware Support Package (HSP) configured for a cluster.

Tip

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

Parameters

packages (dict of str and HardwareSupportPackageSpec) – Map of Hardware Support Packages (HSPs) for the cluster. The key is the Hardware Support Manager (HSM) name and the value is the specification detailing the HSP configured for that HSM. 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.esx.setting.hardware_support.manager. 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.esx.setting.hardware_support.manager.

class com.vmware.esx.settings_client.HostCompliance(impact=None, status=None, notifications=None, scan_time=None, commit=None, base_image=None, add_on=None, hardware_support=None, components=None, solutions=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HostCompliance class contains information to describe the compliance result of a host with respect to given target software specification. DataProcessingUnitCompliance is mirror of this class. Any future changes in either of them should reflect in both.

Tip

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

Parameters

  • impact (ComplianceImpact) – Overall impact.

  • status (ComplianceStatus) – Overall compliance status of the host.

  • notifications (Notifications) – Notifications returned by the scan operation.

  • scan_time (datetime.datetime) – Scan completion time.

  • commit (str or None) – Identifier of the commit on which the scan is run to generate this result. 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. None if operation is performed on a working copy document.

  • base_image (BaseImageCompliance) – Compliance result for the base image.

  • add_on (AddOnCompliance) – Compliance result for the OEM add-on.

  • hardware_support ((dict of str and HardwareSupportPackageCompliance) or None) – Compliance result for hardware support (both Hardware Support Package or HSP and individual hardware module firmware) for every HSP configured, keyed by Hardware Support Manager (HSM). 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.esx.setting.hardware_support.manager. 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.esx.setting.hardware_support.manager. This attribute will be None or contain an empty map if operation is performed on an image whose SoftwareSpec does not have a value for its hardwareSupport attribute.

  • components (dict of str and ComponentCompliance) – Compliance result for all the effective components and all the components present on the host. The key is the component name and value is the ComponentCompliance. 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.esx.settings.component. 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.esx.settings.component.

  • solutions (dict of str and SolutionCompliance) – Compliance result for solutions. The key is the solution name and value is the SolutionCompliance. 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.esx.settings.solution. 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.esx.settings.solution.

class com.vmware.esx.settings_client.HostInfo(name=None, is_vsan_witness=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The HostInfo class contains attributes to describe some details regarding a host in the inventory.

Tip

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

Parameters

  • name (str) – Name of the host.

  • is_vsan_witness (bool or None) – Indicates if the host is associated with a cluster as a vSAN witness. This attribute was added in vSphere API 7.0.2.1. This attribute is set only when the host is associated with a vSAN cluster as a witness.

class com.vmware.esx.settings_client.Notification(type=None, id=None, time=None, message=None, resolution=None, originator=None, retriable=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notification class contains attributes to describe any info/warning/error messages that Tasks can raise.

Tip

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

Parameters

  • type (Notification.Type) – Type of the notification. This attribute was added in vSphere API 7.0.2.0. This attribute is optional because it was added in a newer version than its parent node.

  • id (str) – The notification id.

  • time (datetime.datetime) – The time the notification was raised/found.

  • message (com.vmware.vapi.std_client.LocalizableMessage) – The notification message.

  • resolution (com.vmware.vapi.std_client.LocalizableMessage or None) – The resolution message, if any. Only set if there is a resolution available for this notification.

  • originator (str or None) – The originator of the notification. This attribute was added in vSphere API 7.0.2.0. Only set if there is an originator available for this notification.

  • retriable (bool or None) – Indicates whether the error is retriable. This attribute was added in vSphere API 7.0.2.0. Only set for the notification when a retriable error was reported by the task.

class Type(string)

Bases: vmware.vapi.bindings.enum.Enum

The (\@name Type} class contains the possible different types of notification. This enumeration was added in vSphere API 7.0.2.0.

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.

ERROR = Type(string='ERROR')
INFO = Type(string='INFO')
WARNING = Type(string='WARNING')
class com.vmware.esx.settings_client.Notifications(info=None, warnings=None, errors=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The Notifications class contains info/warning/error messages that can be reported by the task.

Tip

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

Parameters

  • info (list of Notification or None) – Info notification messages reported. Only set if an info was reported by the task.

  • warnings (list of Notification or None) – Warning notification messages reported. Only set if an warning was reported by the task.

  • errors (list of Notification or None) – Error notification messages reported. Only set if an error was reported by the task.

class com.vmware.esx.settings_client.SoftwareInfo(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SoftwareInfo class contains information that describes the desired software specification for an ESX host.

Tip

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

Parameters

  • base_image (BaseImageInfo) – Base image of the ESX.

  • add_on (AddOnInfo or None) – OEM customization on top of given base-image. The components in this customization override the components in the base base-image. If None, no OEM customization will be applied.

  • components (dict of str and ComponentInfo) – Information about the components in the software specification. 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.esx.settings.component. 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.esx.settings.component.

  • solutions (dict of str and SolutionInfo) – Information about the solutions in the software specification. 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.esx.settings.solution. 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.esx.settings.solution.

  • hardware_support (HardwareSupportInfo or None) – Information about the Hardware Support Packages (HSP) configured. If None, no Hardware Support Package (HSP) is specified for the cluster.

class com.vmware.esx.settings_client.SoftwareSpec(base_image=None, add_on=None, components=None, solutions=None, hardware_support=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SoftwareSpec class contains attributes that describe desired software specification for an ESX host.

Tip

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

Parameters

  • base_image (BaseImageSpec) – Base image of the ESX.

  • add_on (AddOnSpec or None) – OEM customization on top of given base-image. The components in this customization override the components in the base base-image. If None, no OEM customization will be applied.

  • components ((dict of str and (str or None)) or None) – Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in SoftwareSpec.add_on and SoftwareSpec.base_image. 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.esx.settings.component. 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.esx.settings.component. If None, no additional components will be installed.

  • solutions ((dict of str and SolutionSpec) or None) – Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution. 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.esx.settings.solution. 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.esx.settings.solution. If None, no solutions will be part of the software specification.

  • hardware_support (HardwareSupportSpec or None) – Information about the Hardware Support Package (HSP) configured in the software specification. If None or empty, no firmware compliance checking or remediation will be done.

class com.vmware.esx.settings_client.SolutionCompliance(status=None, current=None, target=None, notifications=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionCompliance class contains information that describe the compliance result of a host with respect to given solution present in the target software specification.

Tip

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

Parameters

  • status (ComplianceStatus) – Compliance status of the solution.

  • current (SolutionInfo or None) – Current solution present on the host. None if the solution is not present on the host.

  • target (SolutionInfo or None) – Target solution present in the software specification. None if solution is not present in the software specification.

  • notifications (Notifications) – Notifications describing the compliance result.

class com.vmware.esx.settings_client.SolutionComponentDetails(component=None, display_name=None, display_version=None, vendor=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionComponentDetails class contains information that provide more details about component registered by the solution from depot.

Tip

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

Parameters

  • component (str) – Identifier 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.

  • display_version (str or None) – Human readable version of the component. None if no version is provided for the component.

  • vendor (str) – Vendor of the component.

class com.vmware.esx.settings_client.SolutionComponentSpec(component=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionComponentSpec class contains attributes that describe a component registered by a software solution.

Tip

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

Parameters

component (str) – Identifier 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.

class com.vmware.esx.settings_client.SolutionDetails(display_name=None, display_version=None, components=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionDetails class contains information that provide more details about the solution from the depot.

Tip

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

Parameters

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

  • display_version (str) – Display version of the solution.

  • components (list of SolutionComponentDetails) – Components registered by the solution. If the component is not present in the depot, then corresponding details are absent from the list.

class com.vmware.esx.settings_client.SolutionInfo(details=None, version=None, components=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionInfo class contains information that describe solution registered in the software specification.

Tip

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

Parameters

  • details (SolutionDetails or None) – Details about the solution from the depot. None if solution is not present in the depot.

  • version (str) – Version of the solution.

  • components (list of SolutionComponentSpec) – Components registered by the solution.

class com.vmware.esx.settings_client.SolutionSpec(version=None, components=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The SolutionSpec class contains attributes that describe solution registered in the software specification.

Tip

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

Parameters

  • version (str) – Version of the solution.

  • components (list of SolutionComponentSpec) – Components registered by the solution.

class com.vmware.esx.settings_client.Status(string)

Bases: vmware.vapi.bindings.enum.Enum

The 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.

RETRY = Status(string='RETRY')

The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

TIMEOUT = Status(string='TIMEOUT')

The check did not return in a timely manner.

WARNING = Status(string='WARNING')

The check indicates a warning.

class com.vmware.esx.settings_client.StatusInfo(status=None, check_statuses=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The StatusInfo class contains attributes that describe aggregated status of all checks performed on an entity.

Tip

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

Parameters

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

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

class com.vmware.esx.settings_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_client.TaskInfo(progress=None, subtasks=None, notifications=None, result=None, last_update_time=None, description=None, service=None, operation=None, parent=None, target=None, status=None, cancelable=None, error=None, start_time=None, end_time=None, user=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

The TaskInfo class contains information about a task and its subtasks of which it consists.

Tip

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

Parameters

  • progress (com.vmware.cis.task_client.Progress) – Progress of the operation. This attribute is optional and it is only relevant when the value of CommonInfo#status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.

  • subtasks ((dict of str and TaskInfo) or None) – Information about the subtasks that this task contains. 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.cis.task. 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.cis.task. This attribute will be None if the task has no subtasks.

  • notifications (Notifications or None) – Notifications to the user Only set if the notifications were reported by this particular task.

  • result (DataValue or None) – Task result. This attribute will be None if the task has no result.

  • last_update_time (datetime.datetime) – Time when the task was last updated. This attribute was added in vSphere API 7.0.1.0. This attribute is optional because it was added in a newer version than its parent node.

  • description (com.vmware.vapi.std_client.LocalizableMessage) – Description of the operation associated with the task.

  • service (str) – Identifier of the service containing the operation. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.service. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.service.

  • operation (str) – Identifier of the operation associated with the task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vapi.operation. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vapi.operation.

  • parent (str or None) – Parent of the current task. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.cis.task. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.cis.task. This attribute will be None if the task has no parent.

  • target (com.vmware.vapi.std_client.DynamicID or None) – Identifier of the target created by the operation or an existing one the operation performed on. This attribute will be None if the operation has no target or multiple targets.

  • status (com.vmware.cis.task_client.Status) – Status of the operation associated with the task.

  • cancelable (bool) – Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.

  • error (Exception or None) – Description of the error if the operation status is “FAILED”. If None the description of why the operation failed will be included in the result of the operation (see com.vmware.cis.task_client.Info.result).

  • start_time (datetime.datetime) – Time when the operation is started. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.RUNNING, com.vmware.cis.task_client.Status.BLOCKED, com.vmware.cis.task_client.Status.SUCCEEDED, or com.vmware.cis.task_client.Status.FAILED.

  • end_time (datetime.datetime) – Time when the operation is completed. This attribute is optional and it is only relevant when the value of status is one of com.vmware.cis.task_client.Status.SUCCEEDED or com.vmware.cis.task_client.Status.FAILED.

  • user (str or None) – Name of the user who performed the operation. This attribute will be None if the operation is performed by the system.