com.vmware.esx.settings.hardware_support package

Subpackages

Submodules

com.vmware.esx.settings.hardware_support.managers_client module

class com.vmware.esx.settings.hardware_support.managers_client.Packages(config)

Bases: VapiInterface

The Packages class provides methods to manage a host’s Hardware Support Package (HSP) configuration.

Parameters:

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

class FilterSpec(base_image_version=None)

Bases: VapiStruct

The Packages.FilterSpec class contains attributes used to filter the results when listing OEM Hardware Support Packages (HSPs), see Packages.list()).

Tip

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

Parameters:

base_image_version (str or None) – vSphere release version the Hardware Support Package (HSP) must support to match the filter. Only Hardware Support Packages (HSPs) compatible with the vSphere release version specified in ‘baseImageVersion’ will be returned. The ‘baseImageVersion’ parameter should be a full numeric base image version string (e.g. “7.1.0-2.3.436234”). Future implementations may support version specification by prefix (e.g. “7.1” to specify all updates and builds of 7.1) or other forms of specification (e.g. “>=7.0”). Hardware Support Pacakges (HSPs) may be advertised as supporting truncated version strings to indicate the remainder is wildcarded. Matching is on the specified substring only, so a bundle supporting “7.1.0-2” would match a ‘release’ parameter of “7.1.0-2.3.436234” as well as “7.1.0-2.1.4133564” and “7.1.0-1.0.355667” but not “7.1.0-3.0.63445” or any base image version starting with “7.2”. Note that we require compatible base image versions be specified at least down to the update version (i.e. “7.0” is insufficiently constrained) If None, all packages will be returned, regardless of base image version.

class HardwareSupportPackageInfo(pkg=None, version=None, description=None, supported_releases=None)

Bases: VapiStruct

The Packages.HardwareSupportPackageInfo class contains attributes that describe a particular 3rd party Hardware Support Package (HSP)

Tip

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

Parameters:

  • pkg (str) – Name of the Hardware Support Package (e.g. “Jan. 2018 Release” or “Latest Hardware Support Package for Frobozz GenX hardware”) 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 (e.g. “20180128.1” or “v42”) selected

  • description (str) – Description of the Hardware Support Package (HSP) (e.g. for use in help bubble)

  • supported_releases (set of str) – Supported vSphere releases

list(manager, filter=None)

Returns the list of available Hardware Support Packages (HSPs) for a particular host, as specified by its Hardware Support Manager (HSM)

Parameters:

  • manager (str) – Identifier for the Hardware Support Manager (HSM). The parameter must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.

  • filter (Packages.FilterSpec or None) – Specification of Hardware Support Packages (HSPs) to be returned If None, the behavior is equivalent to a Packages.FilterSpec with all attributes None, which means all HSPs match the filter.

Return type:

list of Packages.HardwareSupportPackageInfo

Returns:

List of available Hardware Support Packages (HSPs) for given manager

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 Hardware Support Manager (HSM) with the specified name

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. named manager in the system.

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.managers_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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