Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 02:39:59 -05:00
Code
0735db02a9
vsphere-automation-sdk-python/vsphere/8.0.0.0/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html

604 lines
46 KiB
HTML
Raw Normal View History

Doc Update for M19 and vSphere 8.0.0.0 Signed-off-by: Shweta Purohit <spurohit@vmware.com>
2022-07-14 08:07:12 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package &mdash; vSphere Automation SDK for Python. 8.0.0.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.defaults package" href="com.vmware.esx.settings.defaults.html" />
<link rel="prev" title="com.vmware.esx.settings.clusters.software.reports package" href="com.vmware.esx.settings.clusters.software.reports.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">
8.0.0.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> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.clusters.software.reports.html">com.vmware.esx.settings.clusters.software.reports package</a> &raquo;</li>
<li>com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.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.reports.hardware_compatibility">
<span id="com-vmware-esx-settings-clusters-software-reports-hardware-compatibility-package"></span><h1>com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client">
<span id="com-vmware-esx-settings-clusters-software-reports-hardware-compatibility-storage-device-overrides-client-module"></span><h2>com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_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.hardware_compatibility.storage_device_overrides_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">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_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.stub.VapiInterface</span></code></p>
<p>This class provides methods to manage hardware hardware compatibility
overrides for storage devices. This class was added in vSphere API 7.0.2.1.</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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ComplianceAction</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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction" 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.ComplianceAction</span></code> class enumerates the possible
compliance status overrides for a storage device. 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 <code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceAction</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.FLAG_AS_INCOMPATIBLE">
<code class="sig-name descname"><span class="pre">FLAG_AS_INCOMPATIBLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceAction(string='FLAG_AS_INCOMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.FLAG_AS_INCOMPATIBLE" title="Permalink to this definition"></a></dt>
<dd><p>Specifying this override for a storage device would flag the drive as
non-compliant with VMware Compatibility Guide (VCG). 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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.MARK_AS_VERIFIED">
<code class="sig-name descname"><span class="pre">MARK_AS_VERIFIED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceAction(string='MARK_AS_VERIFIED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.MARK_AS_VERIFIED" title="Permalink to this definition"></a></dt>
<dd><p>Specifying this override for a storage device would ignore the
compatibility issues if any, and treat the drive as compliant with VMware
Compatibility Guide (VCG). 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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.SUPPRESS_WARNING">
<code class="sig-name descname"><span class="pre">SUPPRESS_WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ComplianceAction(string='SUPPRESS_WARNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.SUPPRESS_WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Specifying this override for a storage device would suppress the
compatibility issues if any. 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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Key">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Key</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">capacity</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">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">release</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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Key" 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">ComplianceStatus.Key</span></code> class specifies information about the storage
device for which this override must be applied to. 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>) – </p></li>
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </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>) – storage device part number. This attribute was added in vSphere API
7.0.2.1.
If {\&#64;term.unset} the override will be applied to the entries
without a part number.</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>) – storage device firmware version. This attribute was added in
vSphere API 7.0.2.1.
If {\&#64;term.unset} the override is applied to the entries with an
unknown firmware version.</p></li>
<li><p><strong>release</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – vSphere release that an override must be applied to. This attribute
was added in vSphere API 7.0.2.1.
If this attribute is unset,
<a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a> is
thrown. The field is left optional to support wildcard matching in
a future release.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ReclassificationSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReclassificationSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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">override</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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ReclassificationSpec" 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">ComplianceStatus.ReclassificationSpec</span></code> class contains information
about the storage device and the corresponding override that must be
applied to the specified device. Note: This data structure is specifically
limited to a ‘Key’/’Value’ pair to model smaller changes to the larger
overall set of overrides applicable to a given 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>key</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Key" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Key"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus.Key</span></code></a>) – Information about the storage device for which this override must
be applied to. This attribute was added in vSphere API 7.0.2.1.</p></li>
<li><p><strong>override</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus.ComplianceAction</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance status override for the stroage device. This attribute
was added in vSphere API 7.0.2.1.
If this attribute is None any existing compliance override for the
specified device will be reset.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device_reclassifications</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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec" 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">ComplianceStatus.UpdateSpec</span></code> class describes the updates to be made
to the compatibility overrides for storage devices in a cluster. 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"><p><strong>device_reclassifications</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.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ReclassificationSpec" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ReclassificationSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus.ReclassificationSpec</span></code></a>) – List of compatibility overrides to be applied for the storage
devices in a cluster. This attribute was added in vSphere API
7.0.2.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.update_task">
<code class="sig-name descname"><span class="pre">update_task</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">update_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.update_task" title="Permalink to this definition"></a></dt>
<dd><p>Updates the Compliance staus overrides for storage devices in a
cluster. This method also updates the existing
<a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.CheckResult" title="com.vmware.esx.settings.clusters.software.reports_client.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.CheckResult</span></code></a>
if any, based on the device reclassification specified in
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus.UpdateSpec</span></code></a> The storage device categorization
based on the compliance status from the last check result will remain
the same until a
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check()</span></code>
method is invoked. This method was added in vSphere API 7.0.2.1.</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>) – 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></li>
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus.UpdateSpec</span></code></a>) – Specification for updating the compliance status overrides for
storage devices in a cluster.</p></li>
</ul>
</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 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 the <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.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if one of the values in the update specification is invalid.</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 user cannot be 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 the user doesn’t have the required privileges.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_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.hardware_compatibility.storage_device_overrides_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.hardware_compatibility.storage_device_overrides_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>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.</span></code><code class="sig-name descname"><span class="pre">VcgEntries</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.hardware_compatibility.storage_device_overrides_client.VcgEntries" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>This class provides methods to manage VMware Compatibility Guide (VCG)
product overrides for storage devices in a cluster. This class was added in
vSphere API 7.0.2.1.</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.hardware_compatibility.storage_device_overrides_client.VcgEntries.Key">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Key</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">capacity</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">firmware_version</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.hardware_compatibility.storage_device_overrides_client.VcgEntries.Key" 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">VcgEntries.Key</span></code> class specifies information about the storage device
for which this override must be applied to. 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>) – </p></li>
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – </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>) – storage device part number. This attribute was added in vSphere API
7.0.2.1.
If {\&#64;term.unset} the override will be applied to the entries
without a part number.</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>) – storage device firmware version. This attribute was added in
vSphere API 7.0.2.1.
If {\&#64;term.unset} the override is applied to all firmware
versions.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.ProductSelectionSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ProductSelectionSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.ProductSelectionSpec" 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">VcgEntries.ProductSelectionSpec</span></code> class contains information about
the storage device and the corresponding VMware Compatibility Guide (VCG)
product override that must be applied to the specified 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>key</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.Key" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.Key"><code class="xref py py-class docutils literal notranslate"><span class="pre">VcgEntries.Key</span></code></a>) – Information about the storage device for which this override must
be applied to. This attribute was added in vSphere API 7.0.2.1.</p></li>
<li><p><strong>vcg_product</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>) – VMware Compatibility Guide (VCG) product selection that must be
applied to the specified storage device. 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>.
if {\&#64;term.unset} any existing vcg selection for the storage
device will be removed</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.UpdateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpdateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">product_selections</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.hardware_compatibility.storage_device_overrides_client.VcgEntries.UpdateSpec" 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">VcgEntries.UpdateSpec</span></code> class desribes the updates to be made to the
compatibility overrides for storage devices in a cluster. 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"><p><strong>product_selections</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.hardware_compatibility.storage_device_overrides_client.VcgEntries.ProductSelectionSpec" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.ProductSelectionSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VcgEntries.ProductSelectionSpec</span></code></a>) – List of VMware Compatibility Guide (VCG) overrides to be applied
for the storage devices in a cluster. This attribute was added in
vSphere API 7.0.2.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.update_task">
<code class="sig-name descname"><span class="pre">update_task</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">update_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.update_task" title="Permalink to this definition"></a></dt>
<dd><p>Updates the storage device VMware Compatibility Guide (VCG) product
overrides for a cluster. This method also updates the existing
<a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.CheckResult" title="com.vmware.esx.settings.clusters.software.reports_client.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.CheckResult</span></code></a>
if any, based on the additional information provided by the vcg product
overrides for the devices. The storage device categorization based on
the compliance status from the last check result will remain the same
until a
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check()</span></code>
method is invoked. This method was added in vSphere API 7.0.2.1.</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>) – 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></li>
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.UpdateSpec" title="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">VcgEntries.UpdateSpec</span></code></a>) – Specification for updating the compatibility overrides for the
cluster.</p></li>
</ul>
</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 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 the <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.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if one of the values in the update specification is invalid.</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 user cannot be 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 the user doesn’t have the required privileges.</p>
</dd>
</dl>
</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.defaults.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.defaults 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.software.reports.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.clusters.software.reports package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, 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>
Copy Permalink