<spanid="com-vmware-esx-settings-hardware-support-package"></span><h1>com.vmware.esx.settings.hardware_support package<aclass="headerlink"href="#module-com.vmware.esx.settings.hardware_support"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-esx-settings-hardware-support-managers-client-module"></span><h2>com.vmware.esx.settings.hardware_support.managers_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.hardware_support.managers_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.hardware_support.managers_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Packages</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support.managers_client.Packages"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Packages</span></code> class provides methods to manage a host’s Hardware Support
Package (HSP) configuration.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">base_image_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>base_image_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – 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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HardwareSupportPackageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pkg</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">supported_releases</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Packages.HardwareSupportPackageInfo</span></code> class contains attributes that
describe a particular 3rd party Hardware Support Package (HSP)</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>pkg</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – 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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.setting.hardware_support.package</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the Hardware Support Package (e.g. “20180128.1” or
“v42”) selected</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the Hardware Support Package (HSP) (e.g. for use in
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">manager</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">filter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the list of available Hardware Support Packages (HSPs) for a
particular host, as specified by its Hardware Support Manager (HSM)</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>manager</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the Hardware Support Manager (HSM).
The parameter must be an identifier for the resource type:
<li><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"title="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Packages.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification of Hardware Support Packages (HSPs) to be returned
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"title="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Packages.FilterSpec</span></code></a> with all attributes None, which means
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.hardware_support.managers_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support.managers_client.StubFactory"title="Permalink to this definition">¶</a></dt>
