mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
1705 lines
170 KiB
HTML
1705 lines
170 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.settings.clusters.software package — vSphere Automation SDK for Python. 7.0.3.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 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.clusters.software.drafts package" href="com.vmware.esx.settings.clusters.software.drafts.html" />
|
||
<link rel="prev" title="com.vmware.esx.settings.clusters.policies package" href="com.vmware.esx.settings.clusters.policies.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"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
7.0.3.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.oauth2_client">com.vmware.oauth2_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><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> »</li>
|
||
|
||
<li><a href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a> »</li>
|
||
|
||
<li>com.vmware.esx.settings.clusters.software package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.esx.settings.clusters.software.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.clusters.software">
|
||
<span id="com-vmware-esx-settings-clusters-software-package"></span><h1>com.vmware.esx.settings.clusters.software package<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software" 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.clusters.software.drafts.html">com.vmware.esx.settings.clusters.software.drafts package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#module-com.vmware.esx.settings.clusters.software.drafts.software_client">com.vmware.esx.settings.clusters.software.drafts.software_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html">com.vmware.esx.settings.clusters.software.reports package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_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.clusters.software.drafts_client">
|
||
<span id="com-vmware-esx-settings-clusters-software-drafts-client-module"></span><h2>com.vmware.esx.settings.clusters.software.drafts_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.drafts_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.drafts_client</span></code> module provides
|
||
classes to manage software drafts for ESX cluster.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.drafts_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.drafts_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.drafts_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 class="section" id="module-com.vmware.esx.settings.clusters.software.reports_client">
|
||
<span id="com-vmware-esx-settings-clusters-software-reports-client-module"></span><h2>com.vmware.esx.settings.clusters.software.reports_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.reports_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client</span></code> module
|
||
provides classes to manage reports pertaining to the desired state software for
|
||
a cluster of ESXi hosts.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">ApplyImpact</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact" 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">ApplyImpact</span></code> class provides methods to get the impact of an apply
|
||
method on a cluster.</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.clusters.software.reports_client.ApplyImpact.ApplyImpactSpec">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ApplyImpactSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ApplyImpactSpec" 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">ApplyImpact.ApplyImpactSpec</span></code> class contains attributes that describe
|
||
the specification to be used for getting the impact of an apply method on
|
||
an ESXi cluster.</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>hosts</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The specific hosts for which an impact is to be generated.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will contain identifiers for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
||
if None or empty impact is generated for all hosts within the
|
||
cluster.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ClusterImpact">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ClusterImpact</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">impact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_impact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ClusterImpact" 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">ApplyImpact.ClusterImpact</span></code> class contains attributes that describe
|
||
the summary of how hosts within a cluster will be impacted during an apply
|
||
method.</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>impact</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.settings.clusters.software.reports_client.ApplyImpact.Impact" title="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.Impact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyImpact.Impact</span></code></a>) – Impact of steps performed during the setup and cleanup phase of the
|
||
apply method.</p></li>
|
||
<li><p><strong>host_impact</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.Impact" title="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.Impact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyImpact.Impact</span></code></a>) – Impact summary for each host within the clsuter.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the commit on which the impact is generated.
|
||
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.settings.commit</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.settings.commit</span></code>.</p></li>
|
||
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information of hosts within the cluster.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.Impact">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Impact</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.Impact" 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">ApplyImpact.Impact</span></code> class contains attributes that describe what the
|
||
impact is of a particular step during the apply method.</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>message</strong> (<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>) – Description of the impact.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a summary of how hosts within the cluster will be impacted
|
||
during an apply method. The impact is generated from the compliance
|
||
information obtained from
|
||
<a class="reference internal" href="com.vmware.esx.settings.clusters.html#com.vmware.esx.settings.clusters.software_client.Compliance.get" title="com.vmware.esx.settings.clusters.software_client.Compliance.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software_client.Compliance.get()</span></code></a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
||
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ApplyImpactSpec" title="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ApplyImpactSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyImpact.ApplyImpactSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification for how much information should be returned.</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.clusters.software.reports_client.ApplyImpact.ClusterImpact" title="com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ClusterImpact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyImpact.ClusterImpact</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Summary of how hosts will be impacted during an apply method</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 an 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 cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</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.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.</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.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.CheckResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">CheckResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated_since_last_check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">v_san_data_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_image_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pci_device_compliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage_device_compliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.CheckResult" 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">CheckResult</span></code> class contains information to describe HCL compliance
|
||
result of a cluster on target software specification.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Overall compliance status of Cluster with respective to all hosts
|
||
in the cluster.</p></li>
|
||
<li><p><strong>scan_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – HCL Validation check time.</p></li>
|
||
<li><p><strong>updated_since_last_check</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate if there were any hardware compatibility overrides
|
||
were performed after the last check method. This attribute was
|
||
added in vSphere API 7.0.2.1.
|
||
This attribute is optional because it was added in a newer version
|
||
than its parent node.</p></li>
|
||
<li><p><strong>v_san_data_only</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – HCL Validation Computed only for vSAN Clusters.
|
||
None to show vSAN in UI</p></li>
|
||
<li><p><strong>commit</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>) – Spec Identifier of the desired configuration on which the HCL scan
|
||
is performed to generate this result, populated by the HCL
|
||
validation.
|
||
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.settings.commit</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.settings.commit</span></code>.
|
||
This attribute will be None if validation was performed against a
|
||
draft.</p></li>
|
||
<li><p><strong>base_image_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Target base image version E.g., version = BaseImageSpec->Version
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageSpec.version</span></code> class</p></li>
|
||
<li><p><strong>pci_device_compliance</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance" title="com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">PciDeviceCompliance</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance result for the Pci Devices that are present in all hosts
|
||
of the cluster.
|
||
This attribute will be None if Pci device compliance was not
|
||
computed.</p></li>
|
||
<li><p><strong>storage_device_compliance</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance" title="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDeviceCompliance</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance result for storage devices in all the hosts of the
|
||
cluster. Currently only includes SAS/SATA storage devices. This
|
||
attribute was added in vSphere API 7.0.2.1.
|
||
This attribute will be None if storage device compliance was not
|
||
computed.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications returned by the HCL Validation operation.</p></li>
|
||
<li><p><strong>note</strong> (<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>) – Localizable disclaimer notice to show on the UI detailing the type
|
||
of checks are done by the HCL Validaiton. Example : HCL Validation
|
||
is only done on storage and network controllers.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">ComplianceStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" 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.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComplianceStatus</span></code> class contains the possible different status of
|
||
compliance with respect to target version.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.COMPATIBLE">
|
||
<code class="sig-name descname"><span class="pre">COMPATIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='COMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.COMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target hardware is compliant with VMware Compatibility Guide (VCG)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.HCL_DATA_UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">HCL_DATA_UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='HCL_DATA_UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.HCL_DATA_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HCL data can not be fetched to validate cluster hardware.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.INCOMPATIBLE">
|
||
<code class="sig-name descname"><span class="pre">INCOMPATIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='INCOMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.INCOMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target hardware is not (recognizably) compliant with VMware Compatibility
|
||
Guide (VCG)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.NO_FIRMWARE_PROVIDER">
|
||
<code class="sig-name descname"><span class="pre">NO_FIRMWARE_PROVIDER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='NO_FIRMWARE_PROVIDER')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.NO_FIRMWARE_PROVIDER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No Firmware HSM present in Software Spec to get Firmware Details
|
||
<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportPackageInfo" title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportPackageInfo</span></code></a> class</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target hardware compliance with VMware Compatibility Guide (VCG) cannot be
|
||
determined.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">ComplianceStatusDetail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail" 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.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail</span></code> class contains the essential status values
|
||
for compliance with respect to target VMware Compatibility Guide (VCG).
|
||
This enumeration was added in vSphere API 7.0.2.1.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatusDetail</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.CERTIFIED">
|
||
<code class="sig-name descname"><span class="pre">CERTIFIED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='CERTIFIED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.CERTIFIED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware is specifically certified for target vSphere version according to
|
||
the VCG/HCL. This class attribute was added in vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.FIRMWARE_VERSION_UNKNOWN">
|
||
<code class="sig-name descname"><span class="pre">FIRMWARE_VERSION_UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='FIRMWARE_VERSION_UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.FIRMWARE_VERSION_UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No firmware version information is available (for example no Hardware
|
||
Support Manager, HSM, configured in the cluster’s Software Spec to get
|
||
Firmware Details
|
||
<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportPackageInfo" title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportPackageInfo</span></code></a> class or
|
||
the system failed to retrieve the current firmware version of a device
|
||
using the specified HSM. This class attribute was added in vSphere API
|
||
7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.HCL_DATA_UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">HCL_DATA_UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='HCL_DATA_UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.HCL_DATA_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HCL data can not be fetched to validate cluster hardware. This class
|
||
attribute was added in vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.HOSTS_UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">HOSTS_UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='HOSTS_UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.HOSTS_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hosts in cluster are not available to validate cluster hardware. This class
|
||
attribute was added in vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.MUTED">
|
||
<code class="sig-name descname"><span class="pre">MUTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='MUTED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.MUTED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When a user requests a non-compliance or HCL compliance unavailable warning
|
||
to be suppressed. This class attribute was added in vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.NOT_CERTIFIED">
|
||
<code class="sig-name descname"><span class="pre">NOT_CERTIFIED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='NOT_CERTIFIED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.NOT_CERTIFIED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware is specifically not certified for target vSphere version according
|
||
to the VCG/HCL. This class attribute was added in vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.UNKNOWN">
|
||
<code class="sig-name descname"><span class="pre">UNKNOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When given hardware may be certified for a release but its status can’t be
|
||
definitively determined due to ambiguity in server model, CPU series, or
|
||
BIOS version. This class attribute was added in vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.USER_FLAGGED">
|
||
<code class="sig-name descname"><span class="pre">USER_FLAGGED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='USER_FLAGGED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.USER_FLAGGED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When a server or device’s HCL compliance status has been overridden by the
|
||
user to mark the system as non-compliant. This class attribute was added in
|
||
vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.USER_VERIFIED">
|
||
<code class="sig-name descname"><span class="pre">USER_VERIFIED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='USER_VERIFIED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.USER_VERIFIED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When a server or device’s HCL compliance status has been overridden by the
|
||
user to mark the system as compliant. This class attribute was added in
|
||
vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.VENDOR_UPDATE">
|
||
<code class="sig-name descname"><span class="pre">VENDOR_UPDATE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatusDetail(string='VENDOR_UPDATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.VENDOR_UPDATE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When BIOS or firmware has been updated from a certified entry found in the
|
||
VMware Compatibility Guide (VCG). This class attribute was added in vSphere
|
||
API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">DriverFirmwareVersion</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">driver_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">firmware_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion" 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">DriverFirmwareVersion</span></code> class contains information about device’s
|
||
driver and firmware version combination from Hardware Compatibility List or
|
||
from the target versions from the desired state.</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_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Driver Version.</p></li>
|
||
<li><p><strong>firmware_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Firmware Version. This will be an empty string if the target
|
||
firmware version cannot be determined.</p></li>
|
||
<li><p><strong>driver_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Driver Name.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">HardwareCompatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility" 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">HardwareCompatibility</span></code> class provides methods to manage HCL
|
||
Validation of a software specification of an ESX cluster.</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.clusters.software.reports_client.HardwareCompatibility.CheckSummary">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckSummary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scan_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_image_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary_result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.CheckSummary" 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">HardwareCompatibility.CheckSummary</span></code> class contains information to
|
||
describe the HCL compliance summary result of a cluster on target software
|
||
specification.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus</span></code></a>) – Overall compliance status of the cluster with respective to all
|
||
hosts in the cluster.</p></li>
|
||
<li><p><strong>scan_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – HCL Validation check time.</p></li>
|
||
<li><p><strong>commit</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>) – Spec Identifier of the desired configuration on which the HCL scan
|
||
is performed to generate this result, populated by the HCL
|
||
validation.
|
||
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.settings.commit</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.settings.commit</span></code>.
|
||
This attribute will be None if validation was performed against a
|
||
draft.</p></li>
|
||
<li><p><strong>base_image_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Target base image version E.g., version = BaseImageSpec->Version
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageSpec.version</span></code> class</p></li>
|
||
<li><p><strong>summary_result</strong> (<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>) – Over all Compliance result for cluster for the software
|
||
specification.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications returned by the HCL Validation operation.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComplianceStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus" 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.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus</span></code> class contains the possible
|
||
different status of compliance with respect to target version.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.COMPATIBLE">
|
||
<code class="sig-name descname"><span class="pre">COMPATIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='COMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.COMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target hardware is compliant with VCG/HCL. This includes (from the
|
||
ComplianceStatusDetail:</p>
|
||
<ul class="simple">
|
||
<li><p>COMPLIANT</p></li>
|
||
<li><p>VENDOR_UPDATE</p></li>
|
||
<li><p>USER_OVERRIDE</p></li>
|
||
</ul>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.HCL_DATA_UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">HCL_DATA_UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='HCL_DATA_UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.HCL_DATA_UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>HCL data can not be fetched to validate cluster hardware.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.INCOMPATIBLE">
|
||
<code class="sig-name descname"><span class="pre">INCOMPATIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='INCOMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.INCOMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target hardware is not (recognizably) compliant with VCG/HCL This includes
|
||
(from the ComplianceStatusDetail):</p>
|
||
<ul class="simple">
|
||
<li><p>NONCOMPLIANT</p></li>
|
||
<li><p>USER_FLAGGED</p></li>
|
||
<li><p>NONCOMPLIANCE_MUTED</p></li>
|
||
</ul>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.NO_FIRMWARE_PROVIDER">
|
||
<code class="sig-name descname"><span class="pre">NO_FIRMWARE_PROVIDER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='NO_FIRMWARE_PROVIDER')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.NO_FIRMWARE_PROVIDER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>No Firmware HSM present in Software Spec to get Firmware Details
|
||
<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportPackageInfo" title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportPackageInfo</span></code></a> class</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.UNAVAILABLE">
|
||
<code class="sig-name descname"><span class="pre">UNAVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceStatus(string='UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target hardware compliance with VCG/HCL cannot be determined This includes
|
||
(from the ComplianceStatusDetail):</p>
|
||
<ul class="simple">
|
||
<li><p>HCL_DATA_UNAVAILABLE</p></li>
|
||
<li><p>UNAVAILABLE</p></li>
|
||
<li><p>NO_FIRMWARE_PROVIDER</p></li>
|
||
<li><p>UNKNOWN</p></li>
|
||
</ul>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check_task">
|
||
<code class="sig-name descname"><span class="pre">check_task</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initiates a Cluster HCL Validation check for a given cluster. 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"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
||
</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.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 other unknown internal error. The accompanying
|
||
error message will give more details about the failure and any
|
||
possible resolution(s).</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 cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</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.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-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>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the HCL validation check summary.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of the cluster.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.CheckSummary" title="com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.CheckSummary"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareCompatibility.CheckSummary</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>CheckSummary HCL validation summary.</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 other unknown internal error. The accompanying
|
||
error message will give more details about the failure and any
|
||
possible resolution(s).</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 cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</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.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.</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.HardwareCompatibility.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> 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.settings.clusters.software.reports_client.LastApplyResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">LastApplyResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult" 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">LastApplyResult</span></code> class provides methods to get the most recent
|
||
available result of applying the desired software document to all hosts
|
||
within a cluster.</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.clusters.software.reports_client.LastApplyResult.ApplyResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ApplyResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">successful_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failed_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyResult" 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">LastApplyResult.ApplyResult</span></code> class contains attributes that describe
|
||
the result of an apply method.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus" title="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code></a>) – Specifies the aggregated status of the apply method.</p></li>
|
||
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the commit used to fetch the desired software
|
||
document to be applied to all hosts within the cluster.
|
||
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.settings.commit</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.settings.commit</span></code>.</p></li>
|
||
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information of the hosts in this cluster to which the desired
|
||
software document specified by the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.commit</span></code> should be applied to.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>host_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus" title="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code></a>) – Status of the hosts in this cluster to which the desired software
|
||
document specified by the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.commit</span></code> was applied to. Hosts on
|
||
which the apply method was sucessful are specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.successful_hosts</span></code>. Hosts on
|
||
which the apply method failed are specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.failed_hosts</span></code>. Hosts which were
|
||
skipped by the apply method are specified by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.skipped_hosts</span></code>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>successful_hosts</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>) – Hosts in this cluster to which the desired software document
|
||
specified by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.commit</span></code> has
|
||
been successfully applied to.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will contain identifiers for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>failed_hosts</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>) – Hosts in this cluster to which the desired software document
|
||
specified by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.commit</span></code> failed
|
||
to be applied to.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will contain identifiers for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>skipped_hosts</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>) – Hosts in this cluster that were skipped by the apply method.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
||
return value, the attribute will contain identifiers for the
|
||
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications providing additional information for
|
||
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters_client.Software.apply()</span></code>
|
||
method. These notifications are mutually exclusive with the
|
||
notifications in <code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code>. This attribute
|
||
was added in vSphere API 7.0.2.1.
|
||
This attribute is optional because it was added in a newer version
|
||
than its parent node.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ApplyStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">progress</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus" 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">LastApplyResult.ApplyStatus</span></code> class contains attributes that describe
|
||
the status of an apply method.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status" title="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status</span></code></a>) – The status of the method.</p></li>
|
||
<li><p><strong>progress</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Progress" title="com.vmware.cis.task_client.Progress"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Progress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Progress of the operation. This attribute was added in vSphere API
|
||
7.0.2.1.
|
||
None for #ApplyStatus of the cluster</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method started.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method completed.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications providing additional information about the status of
|
||
the method.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status" 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.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status</span></code> class contains the possible
|
||
different status codes that can be returned while trying to apply the
|
||
desired software specification to hosts within the cluster.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.ERROR">
|
||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.ERROR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The method encountered an unspecified error.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.OK">
|
||
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.OK" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The method completed successfully.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.RETRY_PENDING">
|
||
<code class="sig-name descname"><span class="pre">RETRY_PENDING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='RETRY_PENDING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.RETRY_PENDING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The method is being scheduled for retry. This class attribute was added in
|
||
vSphere API 7.0.2.1.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.SKIPPED">
|
||
<code class="sig-name descname"><span class="pre">SKIPPED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='SKIPPED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.SKIPPED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The method was skipped.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.TIMED_OUT">
|
||
<code class="sig-name descname"><span class="pre">TIMED_OUT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='TIMED_OUT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.TIMED_OUT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The method timed out.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the most recent available result of applying the desired
|
||
software document to all hosts within the cluster.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyResult" title="com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Most recent available result of applying the desired software
|
||
document to all hosts within the cluster.</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 an 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 cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
|
||
if there is no result associated with the cluster <code class="docutils literal notranslate"><span class="pre">cluster</span></code></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.</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.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">LastCheckResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult" 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">LastCheckResult</span></code> class provides methods to get the most recent
|
||
available result of the checks that have been run on a cluster before the
|
||
application of the desired software document to all hosts within the
|
||
cluster.</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.clusters.software.reports_client.LastCheckResult.CheckInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckInfo" 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">LastCheckResult.CheckInfo</span></code> class contains attributes that describe a
|
||
particular check.</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>check</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The check identifier.</p></li>
|
||
<li><p><strong>name</strong> (<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>) – The check name.</p></li>
|
||
<li><p><strong>description</strong> (<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>) – Human-readable check description.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity_results</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckResult" 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">LastCheckResult.CheckResult</span></code> class contains attributes that describe
|
||
aggregated status of all checks performed.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a>) – Aggregated status from all checks performed.</p></li>
|
||
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation started.</p></li>
|
||
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation completed.</p></li>
|
||
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the commit on which checks have been run.
|
||
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.settings.commit</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.settings.commit</span></code>.</p></li>
|
||
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information about the hosts in this cluster for which checks have
|
||
been requested to be run.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>entity_results</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.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult</span></code></a>) – List of <code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult</span></code> for all entities for
|
||
which checks have been run.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckStatus">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CheckStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckStatus" 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">LastCheckResult.CheckStatus</span></code> class contains attributes that describe
|
||
a check result.</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>check</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckInfo" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckInfo</span></code></a>) – Information about this check.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a>) – The status of this check.</p></li>
|
||
<li><p><strong>issues</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>) – The issues encountered while running this check.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EntityCheckResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_statuses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult" 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">LastCheckResult.EntityCheckResult</span></code> class contains attributes that
|
||
describe aggregated status of all checks performed on a specific entity.</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>type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType</span></code></a>) – The entity type for which these checks are being run.</p></li>
|
||
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If the entity type is CLUSTER then the cluster identifier for which
|
||
the checks have been run.
|
||
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">ClusterComputeResource</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">ClusterComputeResource</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.CLUSTER" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.CLUSTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType.CLUSTER</span></code></a>.</p></li>
|
||
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If the entity type is HOST then the host identifier for which the
|
||
checks have been run.
|
||
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">HostSystem</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">HostSystem</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
||
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType.HOST</span></code></a>.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a>) – Aggregated status from all checks performed on this entity.</p></li>
|
||
<li><p><strong>check_statuses</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.settings.clusters.software.reports_client.LastCheckResult.CheckStatus" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckStatus</span></code></a>) – List of <code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckStatus</span></code> for all checks performed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EntityType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType" 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.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType</span></code> class contains the
|
||
entitites on which checks can be performed.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">EntityType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.CLUSTER">
|
||
<code class="sig-name descname"><span class="pre">CLUSTER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">EntityType(string='CLUSTER')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.CLUSTER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Entity type Cluster</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST">
|
||
<code class="sig-name descname"><span class="pre">HOST</span></code><em class="property"> <span class="pre">=</span> <span class="pre">EntityType(string='HOST')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Entity type Host</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status" 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.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code> class defines the status result for a
|
||
particular check.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.ERROR">
|
||
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.ERROR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The check indicates an error.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.OK">
|
||
<code class="sig-name descname"><span class="pre">OK</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.OK" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The check indicates a success.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.TIMEOUT">
|
||
<code class="sig-name descname"><span class="pre">TIMEOUT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='TIMEOUT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.TIMEOUT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The check did not return in a timely manner.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.WARNING">
|
||
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.WARNING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The check indicates a warning.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the most recent available result of checks run on the cluster
|
||
before the application of the desired software document to all hosts
|
||
within the cluster.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckResult" title="com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Most recent result available of the checks run on the cluster.</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 an 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 cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
|
||
if there is no result associated with the cluster <code class="docutils literal notranslate"><span class="pre">cluster</span></code></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.</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.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
||
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
|
||
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.PciDevice">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">PciDevice</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vendor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">did</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">svid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ssid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.PciDevice" 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">PciDevice</span></code> class contains information about a PCI Device.</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>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of the device.</p></li>
|
||
<li><p><strong>driver_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Driver Name of the device.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor Name of the device.</p></li>
|
||
<li><p><strong>vid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – PCI VID of the device.</p></li>
|
||
<li><p><strong>did</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – PCI DID of the device.</p></li>
|
||
<li><p><strong>svid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – PCI SVID of the device.</p></li>
|
||
<li><p><strong>ssid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – PCI SSID of the device.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">PciDeviceCompliance</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatible_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatible_driver_firmware</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance" 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">PciDeviceCompliance</span></code> class contains information that describe the
|
||
compliance result of all pci device from all hosts in the clsuter with
|
||
respect to the component present in the target software specification.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Over all Compliance status of PCI Devices in Cluster with
|
||
respective to all hosts in the cluster.</p></li>
|
||
<li><p><strong>compatible_devices</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.settings.clusters.software.reports_client.PciDeviceComplianceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PciDeviceComplianceInfo</span></code></a>) – Compatible Device Compliance result for all devices present on all
|
||
hosts in the cluster compared with the corresponding component in
|
||
the software specification. The key is the DeviceName and value is
|
||
the PciDeviceComplianceInfo object.</p></li>
|
||
<li><p><strong>incompatible_devices</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.settings.clusters.software.reports_client.PciDeviceComplianceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PciDeviceComplianceInfo</span></code></a>) – Incompatible Device Compliance result for all devices present on
|
||
all hosts in the cluster compared with the corresponding component
|
||
in the software specification. The key is the DeviceName and value
|
||
is the PciDeviceComplianceInfo object.</p></li>
|
||
<li><p><strong>incompatible_driver_firmware</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.settings.clusters.software.reports_client.PciDeviceComplianceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PciDeviceComplianceInfo</span></code></a>) – Incompatible Driver Firmware combination Compliance result for all
|
||
devices present on hosts in the cluster compared with the
|
||
corresponding component in the software specification. The key is
|
||
the DeviceName and value is the PciDeviceComplianceInfo object.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">PciDeviceComplianceInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible_versions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatibility_guide_link</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo" 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">PciDeviceComplianceInfo</span></code> class contains information that describe
|
||
the compliance of a pci device with respect to the component present in the
|
||
target software specification.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the device.</p></li>
|
||
<li><p><strong>device</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.PciDevice" title="com.vmware.esx.settings.clusters.software.reports_client.PciDevice"><code class="xref py py-class docutils literal notranslate"><span class="pre">PciDevice</span></code></a>) – Pci Device Details</p></li>
|
||
<li><p><strong>compatible_versions</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>) – List of vSphere Versions compatible for this device. This field is
|
||
populated only for device found INCOMPATIBLE</p></li>
|
||
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Affected List of Host IDs where this device is found.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion" title="com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion"><code class="xref py py-class docutils literal notranslate"><span class="pre">DriverFirmwareVersion</span></code></a>) – Driver and Firmware Version from Image Specification.</p></li>
|
||
<li><p><strong>supported</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.settings.clusters.software.reports_client.DriverFirmwareVersion" title="com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion"><code class="xref py py-class docutils literal notranslate"><span class="pre">DriverFirmwareVersion</span></code></a>) – List of Supported Driver and Firmware Version combination from
|
||
Harware Compatibility List.</p></li>
|
||
<li><p><strong>compatibility_guide_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>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Device Specific notifications describing the compliance result.
|
||
This attribute will be None if there are no notifications</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompatibility">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">StorageDeviceCompatibility</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible_versions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supported_firmware_versions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vcg_product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partner</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatibility_guide_link</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_for_compliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_selected</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompatibility" 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">StorageDeviceCompatibility</span></code> class contains information that describe
|
||
the compliance of a storage device with respect to the component present in
|
||
the target software specification. This class was added in vSphere API
|
||
7.0.2.1.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the storage device, when computed based on
|
||
this VMware Compatibility Guide (VCG) listing. This attribute was
|
||
added in vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>compatible_versions</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>) – List of vSphere Versions compatible for this storage device. This
|
||
attribute was added in vSphere API 7.0.2.1.
|
||
This attribute will be None if the storage device is certified for
|
||
the target ESXi version.</p></li>
|
||
<li><p><strong>supported_firmware_versions</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>) – List of minimum firmware versions supported from VMware
|
||
Compatibility Guide (VCG) listing for the given vSphere version.
|
||
This attribute was added in vSphere API 7.0.2.1.
|
||
This attribute will be None if the storage device is not certified
|
||
for the target ESXi version or the storage device is only certified
|
||
in combination with specific driver versions, in which case
|
||
listedDriverFirmwareVersions below will be set.</p></li>
|
||
<li><p><strong>vcg_product</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the VMware Compatibility Guide (VCG) listing for the
|
||
product. This attribute was added in vSphere API 7.0.2.1.
|
||
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.settings.vcg_product</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.settings.vcg_product</span></code>.</p></li>
|
||
<li><p><strong>model</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Model name of the storage device as listed in the VMware
|
||
Compatibility Guide (VCG) listing. This may not be the same as the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">StorageDeviceInfo.model</span></code>. This attribute was added in
|
||
vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>partner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – OEM partner name of the storage device as listed in the VMware
|
||
Compatibility Guide (VCG) listing. This attribute was added in
|
||
vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>compatibility_guide_link</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Provides link to the VMware Compatibility Guide (VCG) listing for
|
||
further information on the compatibility. This attribute was added
|
||
in vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>used_for_compliance</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether this VMware compatibility Guide (VCG)
|
||
listing was used to compute the overall compatibility of the
|
||
storage device. This attribute was added in vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>user_selected</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate if the user has selected this VMware Compatibility
|
||
Guide (VCG) listing to be considered to compute the overall
|
||
compatibility of the storage device. This attribute was added in
|
||
vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – VMware compatibility Guide (VCG) listing specific notifications
|
||
describing the compliance result. This attribute was added in
|
||
vSphere API 7.0.2.1.
|
||
This attribute will be None if there are no notifications</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">StorageDeviceCompliance</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compatible_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incompatible_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unknown_devices</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance" 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">StorageDeviceCompliance</span></code> class contains information that describe
|
||
the compliance result of all storage devices from all hosts in the cluster
|
||
with respect to the storage device model and the firmware certification.
|
||
This class was added in vSphere API 7.0.2.1.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Overall compliance status of storage devices in the cluster with
|
||
respect to all hosts in the cluster. This attribute was added in
|
||
vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>compatible_devices</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.settings.clusters.software.reports_client.StorageDeviceComplianceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDeviceComplianceInfo</span></code></a>) – <p>Lists compliance information for storage devices found to be
|
||
compliant with VMware Compatibility Guide (VCG) during the last
|
||
check method.</p>
|
||
<p>Note that complianceStatus of every device is not necessarily
|
||
COMPATIBLE due to changes made after this check was run; entries
|
||
are only rearranged when a new check method is invoked.
|
||
lastOverrideTime being greater than the scanTime is an indication
|
||
that there were changes made after the last check method. This
|
||
attribute was added in vSphere API 7.0.2.1.</p>
|
||
</p></li>
|
||
<li><p><strong>incompatible_devices</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.settings.clusters.software.reports_client.StorageDeviceComplianceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDeviceComplianceInfo</span></code></a>) – <p>Lists compliance information for storage devices found to be
|
||
non-compliant with VMware Compatibility Guide (VCG) during the last
|
||
check method.</p>
|
||
<p>Note that complianceStatus of every device is not necessarily
|
||
INCOMPATIBLE due to changes made after this check was run; entries
|
||
are only rearranged when a new check method is invoked.
|
||
lastOverrideTime being greater than the scanTime is an indication
|
||
that there were changes made after the last check method. This
|
||
attribute was added in vSphere API 7.0.2.1.</p>
|
||
</p></li>
|
||
<li><p><strong>unknown_devices</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.settings.clusters.software.reports_client.StorageDeviceComplianceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDeviceComplianceInfo</span></code></a>) – <p>Lists storage devices whose compliance information could not be
|
||
computed successfully during the last check method.</p>
|
||
<p>Note that complianceStatus of every device is not necessarily
|
||
UNAVAILABLE due to changes made after this check was run; entries
|
||
are only rearranged when a new check method is invoked.
|
||
lastOverrideTime being greater than the scanTime is an indication
|
||
that there were changes made after the last check method. This
|
||
attribute was added in vSphere API 7.0.2.1.</p>
|
||
</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Storage device compliance specific notifications describing the
|
||
compliance result. This attribute was added in vSphere API 7.0.2.1.
|
||
This attribute will be None if there are no notifications</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">StorageDeviceComplianceInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage_device_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">firmware_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">matches</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">used_by_vsan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo" 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">StorageDeviceComplianceInfo</span></code> class contains attributes that describe
|
||
the compliance information of a storage device. This class was added in
|
||
vSphere API 7.0.2.1.</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>storage_device_info</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo" title="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDeviceInfo</span></code></a>) – Information of the storage device. This attribute was added in
|
||
vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the storage device. When there are multiple
|
||
possible VMware Compatibility Guide (VCG) matches for the storage
|
||
device, the compliance status would be set to
|
||
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.UNAVAILABLE" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.UNAVAILABLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ComplianceStatus.UNAVAILABLE</span></code></a> Each match found would be
|
||
listed under <code class="xref py py-attr docutils literal notranslate"><span class="pre">StorageDeviceComplianceInfo.matches</span></code> with the
|
||
corresponding compliance status of the storage device if compared
|
||
against the constraints specified in the match. This attribute was
|
||
added in vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>detail</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail" title="com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatusDetail</span></code></a>) – Detailed compliance status of the storage device. This attribute
|
||
was added in vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Affected List of Host IDs where this device is found. This
|
||
attribute was added in vSphere API 7.0.2.1.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as
|
||
a return value, the key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
|
||
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
||
<li><p><strong>firmware_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>) – Firmware version on the storage device. This attribute was added in
|
||
vSphere API 7.0.2.1.
|
||
This attribute will be None if the firmware version on the storage
|
||
device is unknown, cannot be determined or the compliance status of
|
||
the device is determined by driver and firmware combination.</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.settings.clusters.software.reports_client.StorageDeviceCompatibility" title="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompatibility"><code class="xref py py-class docutils literal notranslate"><span class="pre">StorageDeviceCompatibility</span></code></a>) – <p>Provides information about possible compatibility matches for the
|
||
given storage device.</p>
|
||
<p>There could be multiple possible matches available in the
|
||
compatibility data.. This attribute was added in vSphere API
|
||
7.0.2.1.</p>
|
||
</p></li>
|
||
<li><p><strong>used_by_vsan</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates if the storage device is in use by vSAN. When this flag
|
||
is set to true, the hardware compatibility is computed against vSAN
|
||
HCL constraints. This attribute was added in vSphere API 7.0.2.1.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Device Specific notifications describing the compliance result.
|
||
This attribute was added in vSphere API 7.0.2.1.
|
||
This attribute will be None if there are no notifications</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">StorageDeviceInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vendor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">part_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">capacity</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo" 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">StorageDeviceInfo</span></code> class contains attributes describing a storage
|
||
device. This class was added in vSphere API 7.0.2.1.</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>model</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Storage device model. This attribute was added in vSphere API
|
||
7.0.2.1.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Storage device vendor. This attribute was added in vSphere API
|
||
7.0.2.1.</p></li>
|
||
<li><p><strong>part_number</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>) – Hardware part number of the storage device. This attribute was
|
||
added in vSphere API 7.0.2.1.
|
||
This attribute will be unest if part number information is not
|
||
available for the storage device.</p></li>
|
||
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Capacity of the storage device in bytes. This attribute was added
|
||
in vSphere API 7.0.2.1.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings.clusters.software.reports_client.StubFactory">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports_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.clusters.software.drafts.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.clusters.software.drafts package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
<a href="com.vmware.esx.settings.clusters.policies.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.clusters.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2021, VMware, Inc..
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
|
||
<a href="https://github.com/readthedocs/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> |