mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 20:09:58 -05:00
696 lines
51 KiB
HTML
696 lines
51 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!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.hcl package — 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.hosts package" href="com.vmware.esx.hosts.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.esx package" href="com.vmware.esx.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> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.esx.hcl package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.esx.hcl.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.hcl">
|
|||
|
|
<span id="com-vmware-esx-hcl-package"></span><h1>com.vmware.esx.hcl package<a class="headerlink" href="#module-com.vmware.esx.hcl" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<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.hcl.hosts_client">
|
|||
|
|
<span id="com-vmware-esx-hcl-hosts-client-module"></span><h2>com.vmware.esx.hcl.hosts_client module<a class="headerlink" href="#module-com.vmware.esx.hcl.hosts_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReleases">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl.hosts_client.</code><code class="sig-name descname">CompatibilityReleases</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.hcl.hosts_client.CompatibilityReleases" 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>This class provides methods to list available releases for generating
|
|||
|
|
compatibility report for a specific ESXi host.</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.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">EsxiCompatibilityReleases</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">current_compatibility_release</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">newer_compatibility_releases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReleases.EsxiCompatibilityReleases</span></code> class contains
|
|||
|
|
attributes that describe available releases for generating compatibility
|
|||
|
|
report for a specific ESXi host.</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>current_compatibility_release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The current release of the ESXi, which also can be checked for
|
|||
|
|
compatibility.</p>
|
|||
|
|
<p>The information for the release does not include patch information.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>newer_compatibility_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The available ESXi releases, greater than the current one, than can
|
|||
|
|
be checked for compatibility.</p></li>
|
|||
|
|
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Notifications" title="com.vmware.esx.hcl_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Notifications</span></code></a>) – Notifications returned by the operation.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Lists the locally available ESXi releases for a given host that can be
|
|||
|
|
used to generate a compatiblity report. Each host has its own list of
|
|||
|
|
supported releases depending on its current release.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Contains the MoID identifying the ESXi host.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases" title="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.EsxiCompatibilityReleases"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReleases.EsxiCompatibilityReleases</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Available releases for compatibility for a specified host.</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.InternalServerError" title="com.vmware.vapi.std.errors_client.InternalServerError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InternalServerError</span></code></a>
|
|||
|
|
If there is some 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if there is no compatibility data on the vCenter executing the
|
|||
|
|
operation.</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.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 no host with the given MoID can be found.</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.</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.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the provided host is not supported.</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.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the vCenter this API is executed on is not part of the Customer
|
|||
|
|
Experience Improvement Program (CEIP).</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 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.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.HardwareCompatibility.Read</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl.hosts_client.</code><code class="sig-name descname">CompatibilityReport</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.hcl.hosts_client.CompatibilityReport" 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>This class provides methods to generate hardware compatibility report for a
|
|||
|
|
given ESXi host against a specific ESXi release.</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.hcl.hosts_client.CompatibilityReport.BiosConstraint">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">BiosConstraint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bios</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.BiosConstraint</span></code> class contains attributes that
|
|||
|
|
describe the BIOS that is supported for the given server and ESXi release.</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>bios</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Firmware" title="com.vmware.esx.hcl_client.Firmware"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Firmware</span></code></a>) – The BIOS information about the constraint.</p></li>
|
|||
|
|
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Any information that should be taken into account when reviewing
|
|||
|
|
the BIOS constraint.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DeviceConstraint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">driver</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">firmware</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceConstraint</span></code> class contains attributes
|
|||
|
|
that describe pair of driver and firmware that are supported for a given
|
|||
|
|
PCI device and ESXi release.</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>driver</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Driver" title="com.vmware.esx.hcl_client.Driver"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Driver</span></code></a>) – The driver information about the constraint.</p></li>
|
|||
|
|
<li><p><strong>firmware</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Firmware" title="com.vmware.esx.hcl_client.Firmware"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Firmware</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The firmware information about the constraint.
|
|||
|
|
If None there is no firmware restriction on the driver to work with
|
|||
|
|
that release.</p></li>
|
|||
|
|
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Any information that should be taken into account when reviewing
|
|||
|
|
the device constraint.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">DeviceHclInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">compatibility</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">device</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">device_constraints</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>, <em class="sig-param"><span class="n">vcg_link</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceHclInfo</span></code> class contains attributes that
|
|||
|
|
describe a PCI device of a given ESXi host and its compatibility
|
|||
|
|
information.</p>
|
|||
|
|
<p>If there are multiple PCI devices of the same type on the host each one
|
|||
|
|
will be listed in separate instance of this class.</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>compatibility</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.CompatibilityStatus" title="com.vmware.esx.hcl_client.CompatibilityStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.CompatibilityStatus</span></code></a>) – Indicates compatibility status of the PCI device.</p></li>
|
|||
|
|
<li><p><strong>device</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.PCIDevice" title="com.vmware.esx.hcl_client.PCIDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.PCIDevice</span></code></a>) – Information about the PCI device.</p></li>
|
|||
|
|
<li><p><strong>device_constraints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceConstraint"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceConstraint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists the constraints the target ESXi release has for this PCI
|
|||
|
|
device
|
|||
|
|
If None no constraints are present as PCI device is either not
|
|||
|
|
compatible or compatibility information is not found.</p></li>
|
|||
|
|
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <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>) – Provides information about supported releases for this device.
|
|||
|
|
If None device is compatible with the given target release.</p></li>
|
|||
|
|
<li><p><strong>vcg_link</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>) – Provides link to the VMware Compatibility Guide for further
|
|||
|
|
information on the compatibility.
|
|||
|
|
If None there is no VMware Compatibility link available as this is
|
|||
|
|
device used by VSAN.</p></li>
|
|||
|
|
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information that needs to be taken into account when considering
|
|||
|
|
this device hcl.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is any information reported.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">HclReport</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target_release</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">server_hcl</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">devices_hcl</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">generated_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport</span></code> represents the hardware
|
|||
|
|
compatibility report generated for a specific host and target ESXi release.</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>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – FQDN identifying the ESXi host that the report refers to.</p></li>
|
|||
|
|
<li><p><strong>target_release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Indicates for which ESXi release the report is generated.</p></li>
|
|||
|
|
<li><p><strong>server_hcl</strong> (<a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.ServerHclInfo</span></code></a>) – Lists compatibility information for the ESXi’s server part.</p></li>
|
|||
|
|
<li><p><strong>devices_hcl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.DeviceHclInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.DeviceHclInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists compatibility information for discoverable PCI devices of the
|
|||
|
|
host.
|
|||
|
|
If None the server is not compatible with the requested release and
|
|||
|
|
the PCI devices cannot be checked.</p></li>
|
|||
|
|
<li><p><strong>generated_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Specifies the time the report was generated.</p></li>
|
|||
|
|
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Notifications" title="com.vmware.esx.hcl_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Notifications</span></code></a>) – Notifications returned by the operation.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Result</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">report</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">identifier</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result" 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">CompatibilityReport.Result</span></code> class contains the result of hardware
|
|||
|
|
compatibility report creation operation.</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>report</strong> (<a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.HclReport"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport</span></code></a>) – The hardware compatibility report.</p></li>
|
|||
|
|
<li><p><strong>identifier</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>) – <p>The identifier of the compatibility report.</p>
|
|||
|
|
<p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Reports.get" title="com.vmware.esx.hcl_client.Reports.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Reports.get()</span></code></a> provides location
|
|||
|
|
where a file based report based on the
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport</span></code> can be downloaded using this
|
|||
|
|
identifier.
|
|||
|
|
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.hcl.resources.CompatibilityReport</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.hcl.resources.CompatibilityReport</span></code>.
|
|||
|
|
None in case of error reported in
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">CompatibilityReport.HclReport.notifications</span></code>.</p>
|
|||
|
|
</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ServerCompatibility</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bios_constraints</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_series</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>, <em class="sig-param"><span class="n">vcg_link</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notes</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.ServerCompatibility</span></code> class contains attributes
|
|||
|
|
that provide the compatibility information for a server model, cpu and
|
|||
|
|
BIOS.</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>bios_constraints</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.BiosConstraint"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.BiosConstraint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists the BIOS constraints that the target ESXi release has for
|
|||
|
|
this server.
|
|||
|
|
If None no constraints are present as server is either not
|
|||
|
|
compatible or compatibility information is not found.</p></li>
|
|||
|
|
<li><p><strong>cpu_series</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The CPU series name.</p></li>
|
|||
|
|
<li><p><strong>supported_releases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <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>) – Provides information about supported releases for this entry.
|
|||
|
|
If None server is compatible with the given target release.</p></li>
|
|||
|
|
<li><p><strong>vcg_link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provides link to the VMware Compatibility Guide for further
|
|||
|
|
information on the compatibility.</p></li>
|
|||
|
|
<li><p><strong>notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information that needs to be taken into account when considering
|
|||
|
|
this server hardware compatibility.
|
|||
|
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is any information reported.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ServerHclInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">server</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">matches</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">model_compatibility</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerHclInfo" 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>This <code class="docutils literal notranslate"><span class="pre">CompatibilityReport.ServerHclInfo</span></code> class contains attributes that
|
|||
|
|
describe the server of a ESXi host and its compatibility information.</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>server</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.Server" title="com.vmware.esx.hcl_client.Server"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.Server</span></code></a>) – Information about the server.</p></li>
|
|||
|
|
<li><p><strong>matches</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.ServerCompatibility"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.ServerCompatibility</span></code></a>) – <p>Provides information about possible compatibility matches for the
|
|||
|
|
given server.</p>
|
|||
|
|
<p>There could be multiple matches returned as there are several
|
|||
|
|
possible matches in the Compatibility data.</p>
|
|||
|
|
</p></li>
|
|||
|
|
<li><p><strong>model_compatibility</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.hcl_client.CompatibilityStatus" title="com.vmware.esx.hcl_client.CompatibilityStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client.CompatibilityStatus</span></code></a>) – Shows if the server model is compatible with given target ESXi
|
|||
|
|
release.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">release</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec" 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">CompatibilityReport.Spec</span></code> class contains attributes to describe the
|
|||
|
|
input configuration for an ESXi’s compatibility report generation.</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>release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A target ESXi release which will be used to generate a
|
|||
|
|
compatibility report. Releases that can be used to generate report
|
|||
|
|
can be found using <a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list" title="com.vmware.esx.hcl.hosts_client.CompatibilityReleases.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">CompatibilityReleases.list()</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.create_task">
|
|||
|
|
<code class="sig-name descname">create_task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span></em>, <em class="sig-param"><span class="n">spec</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.create_task" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Generates hardware compatibility report for a specified ESXi host
|
|||
|
|
against specific ESXi release.</p>
|
|||
|
|
<p>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.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Contains the MoID identifying the ESXi host.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.Spec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the input parameters for generating compatibility report.
|
|||
|
|
If None host compatibility will be checked against the current
|
|||
|
|
release of the ESXi.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class</dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>Task instance</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 no host with the given MoID can be found.</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.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.</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.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the provided host is not supported.</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.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the vCenter this API is executed on is not part of the Customer
|
|||
|
|
Experience Improvement Program (CEIP).</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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
if there is no compatibility data on the vCenter executing the
|
|||
|
|
operation.</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 error. The accompanying error message will
|
|||
|
|
give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.CompatibilityReport.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">host</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns the last generated hardware compatibility report for the given
|
|||
|
|
host.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result" title="com.vmware.esx.hcl.hosts_client.CompatibilityReport.Result"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityReport.Result</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p></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.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 report generated for the given host. This operation
|
|||
|
|
does not check if the host id is valid or it exists.</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.</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.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
|||
|
|
if the vCenter this API is executed on is not part of the Customer
|
|||
|
|
Experience Improvement Program (CEIP).</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.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 error. The accompanying error message will
|
|||
|
|
give more details about the failure.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.hcl.hosts_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl.hosts_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.hcl.hosts_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.hosts.html" class="btn btn-neutral float-right" title="com.vmware.esx.hosts package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.esx.html" class="btn btn-neutral float-left" title="com.vmware.esx package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© 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>
|