com.vmware.esx.settings.hardware_support.managers package

Submodules

com.vmware.esx.settings.hardware_support.managers.packages_client module

class com.vmware.esx.settings.hardware_support.managers.packages_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

class com.vmware.esx.settings.hardware_support.managers.packages_client.Versions(config)

Bases: VapiInterface

The Versions class provides methods to inspect a Hardware Support Package (HSP)’s detailed information.

Parameters:

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

class ComponentInfo(name=None, display_name=None, version=None, display_version=None)

Bases: VapiStruct

The Versions.ComponentInfo class defines the information regarding a component present in HSP manifest.

Tip

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

Parameters:

  • name (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.

  • version (str) – Version of the component.

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

class FilterSpec(base_image_version=None)

Bases: VapiStruct

The Versions.FilterSpec class contains attributes used to filter the results when retrieving Hardware Support Packages (HSPs) information.

Tip

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

Parameters:

base_image_version (str or None) – vSphere release version for the component information in the Hardware Support Package (HSP). 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-2.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 supported releases will be returned but no specific component information (added or deleted) will be included.

class PackageInfo(pkg=None, version=None, description=None, supported_releases=None, components=None, removed_components=None)

Bases: VapiStruct

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

  • components (list of Versions.ComponentInfo) – List of components in this HSP manifest.

  • removed_components (list of Versions.RemovedComponentInfo) – List of components removed by this HSP manifest.

class RemovedComponentInfo(name=None, display_name=None)

Bases: VapiStruct

The Versions.RemovedComponentInfo class defines the information regarding a component removed by the HSP manifest.

Tip

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

Parameters:

  • name (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.

get(manager, pkg, version, filter=None)

Returns the detailed information for a specific version of an available Hardware Support Packages (HSPs) as specified by the 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.

  • pkg (str) – The name of the Hardware Support Package (HSP) The parameter must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.package.

  • version (str) – The version of the Hardware Support Package (HSP)

  • filter (Versions.FilterSpec or None) – Specification of detailed information to be returned If None, the behavior is equivalent to a Versions.FilterSpec with all attributes None, which means all releases supported are returned but no component information for any particular release is included.

Return type:

Versions.PackageInfo

Returns:

detailed information on Hardware Support Packages (HSPs)

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.InvalidArgument If any of the specified parameters are Invalid (e.g. if the release version specified in the query parameter is not, in fact, among those supported by the Hardware Support Package (HSP).

Raise:

com.vmware.vapi.std.errors_client.NotFound If there is no Hardware Support Manager (HSM) with the specified name, or no Hardware Support Package (HSP) with the specified name and version.

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 the user does not have the required privilege to perform the operation.

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.