Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-26 19:29:58 -05:00
Code
c4d59809af
vsphere-automation-sdk-python/vsphere/7.0.1.0/com.vmware.esx.settings.hardware_support.html

408 lines
22 KiB
HTML
Raw Normal View History

adding vSphere 7.0 U1 artifacts
2020-10-12 01:13:57 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.esx.settings.hardware_support package &mdash; vSphere Automation SDK for Python. 7.0.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.esx.settings.hardware_support.managers package" href="com.vmware.esx.settings.hardware_support.managers.html" />
<link rel="prev" title="com.vmware.esx.settings.depot_content package" href="com.vmware.esx.settings.depot_content.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> &raquo;</li>
<li>com.vmware.esx.settings.hardware_support package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.esx.settings.hardware_support.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.esx.settings.hardware_support">
<span id="com-vmware-esx-settings-hardware-support-package"></span><h1>com.vmware.esx.settings.hardware_support package<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html">com.vmware.esx.settings.hardware_support.managers package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#module-com.vmware.esx.settings.hardware_support.managers.packages_client">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.esx.settings.hardware_support.managers_client">
<span id="com-vmware-esx-settings-hardware-support-managers-client-module"></span><h2>com.vmware.esx.settings.hardware_support.managers_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hardware_support.managers_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.hardware_support.managers_client.</code><code class="sig-name descname">Packages</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Packages</span></code> class provides methods to manage a host’s Hardware Support
Package (HSP) configuration.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec">
<em class="property">class </em><code class="sig-name descname">FilterSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">base_image_version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Packages.FilterSpec</span></code> class contains attributes used to filter the
results when listing OEM Hardware Support Packages (HSPs), see
<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.list" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Packages.list()</span></code></a>).</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>base_image_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="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. “&gt;=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.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo">
<em class="property">class </em><code class="sig-name descname">HardwareSupportPackageInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pkg</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">supported_releases</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Packages.HardwareSupportPackageInfo</span></code> class contains attributes that
describe a particular 3rd party Hardware Support Package (HSP)</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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:
<code class="docutils literal notranslate"><span class="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
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the Hardware Support Package (e.g. “20180128.1” or
“v42”) selected</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description of the Hardware Support Package (HSP) (e.g. for use in
help bubble)</p></li>
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Supported vSphere releases</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.hardware_support.managers_client.Packages.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">manager</span></em>, <em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>manager</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Hardware Support Manager (HSM).
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.manager</span></code>.</p></li>
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Packages.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification of Hardware Support Packages (HSPs) to be returned
If None, the behavior is equivalent to a
<a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Packages.FilterSpec</span></code></a> with all attributes None, which means
all HSPs match the filter.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.list" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo" title="com.vmware.esx.settings.hardware_support.managers_client.Packages.HardwareSupportPackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Packages.HardwareSupportPackageInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of available Hardware Support Packages (HSPs) for given
manager</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no Hardware Support Manager (HSM) with the specified
name</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated. named <code class="docutils literal notranslate"><span class="pre">manager</span></code> in the
system.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.hardware_support.managers_client.StubFactory">
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.hardware_support.managers_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hardware_support.managers_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.esx.settings.hardware_support.managers.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.hardware_support.managers package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.esx.settings.depot_content.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.depot_content package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2020, VMware, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink