mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 01:39:58 -05:00
2297 lines
217 KiB
HTML
2297 lines
217 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 package — vSphere Automation SDK for Python. 7.0.1.0 documentation</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.esx.hcl package" href="com.vmware.esx.hcl.html" />
|
||
<link rel="prev" title="com.vmware.content.type.ovf package" href="com.vmware.content.type.ovf.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home" alt="Documentation Home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
7.0.1.0
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li>com.vmware.esx package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.esx.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">
|
||
<span id="com-vmware-esx-package"></span><h1>com.vmware.esx package<a class="headerlink" href="#module-com.vmware.esx" 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.hcl.html">com.vmware.esx.hcl package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hcl.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hcl.html#module-com.vmware.esx.hcl.hosts_client">com.vmware.esx.hcl.hosts_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.hosts.html">com.vmware.esx.hosts package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hosts.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.hosts.health.html">com.vmware.esx.hosts.health package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hosts.health.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.hosts.health.html#module-com.vmware.esx.hosts.health.perspectives_client">com.vmware.esx.hosts.health.perspectives_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hosts.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.hosts.html#module-com.vmware.esx.hosts.software_client">com.vmware.esx.hosts.software_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html">com.vmware.esx.settings.clusters.policies package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#module-com.vmware.esx.settings.clusters.policies.apply_client">com.vmware.esx.settings.clusters.policies.apply_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><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-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><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-l7"><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-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><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>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.drafts_client">com.vmware.esx.settings.clusters.software.drafts_client module</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.reports_client">com.vmware.esx.settings.clusters.software.reports_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.enablement_client">com.vmware.esx.settings.clusters.enablement_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.policies_client">com.vmware.esx.settings.clusters.policies_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.html#module-com.vmware.esx.settings.clusters.software_client">com.vmware.esx.settings.clusters.software_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.defaults.html">com.vmware.esx.settings.defaults package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html">com.vmware.esx.settings.defaults.clusters package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html">com.vmware.esx.settings.defaults.clusters.policies package</a><ul>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.policies.html#module-com.vmware.esx.settings.defaults.clusters.policies.apply_client">com.vmware.esx.settings.defaults.clusters.policies.apply_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.defaults.clusters.html#module-com.vmware.esx.settings.defaults.clusters.policies_client">com.vmware.esx.settings.defaults.clusters.policies_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.defaults.html#module-com.vmware.esx.settings.defaults.clusters_client">com.vmware.esx.settings.defaults.clusters_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html">com.vmware.esx.settings.depot_content package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.add_ons_client">com.vmware.esx.settings.depot_content.add_ons_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.base_images_client">com.vmware.esx.settings.depot_content.base_images_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.depot_content.html#module-com.vmware.esx.settings.depot_content.components_client">com.vmware.esx.settings.depot_content.components_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html">com.vmware.esx.settings.hardware_support package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html">com.vmware.esx.settings.hardware_support.managers package</a><ul>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.managers.html#module-com.vmware.esx.settings.hardware_support.managers.packages_client">com.vmware.esx.settings.hardware_support.managers.packages_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hardware_support.html#module-com.vmware.esx.settings.hardware_support.managers_client">com.vmware.esx.settings.hardware_support.managers_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.clusters_client">com.vmware.esx.settings.clusters_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.defaults_client">com.vmware.esx.settings.defaults_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.depot_content_client">com.vmware.esx.settings.depot_content_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.depots_client">com.vmware.esx.settings.depots_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.hardware_support_client">com.vmware.esx.settings.hardware_support_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.html#module-com.vmware.esx.settings.hosts_client">com.vmware.esx.settings.hosts_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.hcl_client">
|
||
<span id="com-vmware-esx-hcl-client-module"></span><h2>com.vmware.esx.hcl_client module<a class="headerlink" href="#module-com.vmware.esx.hcl_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hcl_client</span></code> module provides classes to query the hardware
|
||
compatibility for an ESXi or a cluster.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityData">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">CompatibilityData</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityData" 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 update the local compatibility data residing
|
||
on the vCenter Appliance or to get information about the said data. The
|
||
information in the data is generic VMware compatibility information for
|
||
servers and devices.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityData.Status">
|
||
<em class="property">class </em><code class="sig-name descname">Status</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">updated_at</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityData.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.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">CompatibilityData.Status</span></code> class contains attributes to describe the
|
||
information available for the compatibility data.</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>updated_at</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Indicates when the data was last updated.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#com.vmware.esx.hcl_client.Notifications" title="com.vmware.esx.hcl_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notifications</span></code></a>) – Notifications returned by the operation.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityData.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityData.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Provides information about the compatibility data located on the
|
||
vCenter Appliance.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.esx.hcl_client.CompatibilityData.Status" title="com.vmware.esx.hcl_client.CompatibilityData.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityData.Status</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Information about the compatibility data.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if there is no compatibility data on the vCenter executing the
|
||
operation.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the vCenter this API is executed on is not part of the Customer
|
||
Experience Improvement Program (CEIP).</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown error. The accompanying error message will
|
||
give more details about the failure.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
||
if you do not have all of the privileges described as follows:</p>
|
||
<ul class="simple">
|
||
<li><p>Method execution requires
|
||
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.HardwareCompatibility.Read</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityData.update_task">
|
||
<code class="sig-name descname">update_task</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityData.update_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Replaces the local compatibility data with the latest version found
|
||
from VMware official source.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
||
if there is compatibility data update in progress.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the vCenter this API is executed on is not part of the Customer
|
||
Experience Improvement Program (CEIP).</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown error. The accompanying error message will
|
||
give more details about the failure.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityStatus">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">CompatibilityStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityStatus" 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">CompatibilityStatus</span></code> class defines compatibility status of a given
|
||
server or PCI device against a specific release of ESXi.</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.hcl_client.CompatibilityStatus" title="com.vmware.esx.hcl_client.CompatibilityStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompatibilityStatus</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityStatus.CERTIFIED">
|
||
<code class="sig-name descname">CERTIFIED</code><em class="property"> = CompatibilityStatus(string='CERTIFIED')</em><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityStatus.CERTIFIED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When given hardware is certified for the specified ESXi release. Its
|
||
software is also validated and it is also certified.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityStatus.COMPATIBLE">
|
||
<code class="sig-name descname">COMPATIBLE</code><em class="property"> = CompatibilityStatus(string='COMPATIBLE')</em><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityStatus.COMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When given hardware is certified for the specified ESXi release but no
|
||
validation of the software of this hardware is performed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityStatus.INCOMPATIBLE">
|
||
<code class="sig-name descname">INCOMPATIBLE</code><em class="property"> = CompatibilityStatus(string='INCOMPATIBLE')</em><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityStatus.INCOMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When given hardware is not certified for the specified ESXi release.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityStatus.NOT_CERTIFIED">
|
||
<code class="sig-name descname">NOT_CERTIFIED</code><em class="property"> = CompatibilityStatus(string='NOT_CERTIFIED')</em><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityStatus.NOT_CERTIFIED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When given hardware is certified for the specified ESXi release. Its
|
||
software is also validated and it is not certified.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.hcl_client.CompatibilityStatus.UNAVAILABLE">
|
||
<code class="sig-name descname">UNAVAILABLE</code><em class="property"> = CompatibilityStatus(string='UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.esx.hcl_client.CompatibilityStatus.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When there is no information about specified hardware.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Driver">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">Driver</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Driver" 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">Driver</span></code> class contains attributes describing information about a
|
||
driver.</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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the driver.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the driver.</p></li>
|
||
<li><p><strong>vendor</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>) – The vendor that produced the driver.
|
||
If None vendor is unknown.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Firmware">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">Firmware</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Firmware" 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">Firmware</span></code> class contains attributes describing information about a
|
||
firmware.</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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the firmware.</p></li>
|
||
<li><p><strong>vendor</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>) – The vendor that produced the firmware.
|
||
If None vendor is unknown.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Notification">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">Notification</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resolution</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Notification" 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">Notification</span></code> class contains attributes to describe any
|
||
info/warning/error messages that Tasks can raise.</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The notification id.</p></li>
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The time the notification was raised/found.</p></li>
|
||
<li><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>) – The notification message.</p></li>
|
||
<li><p><strong>resolution</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The resolution message, if any.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is a resolution available for this
|
||
notification.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Notifications">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">Notifications</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warnings</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">errors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Notifications" 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">Notifications</span></code> class contains info/warning/error messages that can
|
||
be reported be the task.</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>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl_client.Notification" title="com.vmware.esx.hcl_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Info notification messages reported.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the task.</p></li>
|
||
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl_client.Notification" title="com.vmware.esx.hcl_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Warning notification messages reported.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the task.</p></li>
|
||
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.hcl_client.Notification" title="com.vmware.esx.hcl_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error notification messages reported.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the task.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.PCIDevice">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">PCIDevice</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pci_address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">did</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">svid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ssid</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">model_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">class_code</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sub_class_code</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">driver</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">firmware</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">used_by_vsan</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_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 attributes describing information about a
|
||
single PCI device on a host.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>pci_address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The device’s address in a given ESXi host.</p></li>
|
||
<li><p><strong>vid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique number assigned to each computer hardware device that
|
||
helps to identify the chipset manufacturer. For example, Dell,
|
||
Broadcom, etc.</p></li>
|
||
<li><p><strong>did</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique number that identifies the specific device of the Vendor
|
||
(VID).</p></li>
|
||
<li><p><strong>svid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique number that identifies the card manufacturer.</p></li>
|
||
<li><p><strong>ssid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A unique number that identifies the specific device of Subsystem
|
||
Vendor (SVID).</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the vendor.</p></li>
|
||
<li><p><strong>model_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the device model.</p></li>
|
||
<li><p><strong>class_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Register that specifies the type of function the device performs.</p></li>
|
||
<li><p><strong>sub_class_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Register that specifies the specific function the device performs.</p></li>
|
||
<li><p><strong>driver</strong> (<a class="reference internal" href="#com.vmware.esx.hcl_client.Driver" title="com.vmware.esx.hcl_client.Driver"><code class="xref py py-class docutils literal notranslate"><span class="pre">Driver</span></code></a>) – Currently installed driver used by the device.</p></li>
|
||
<li><p><strong>firmware</strong> (<a class="reference internal" href="#com.vmware.esx.hcl_client.Firmware" title="com.vmware.esx.hcl_client.Firmware"><code class="xref py py-class docutils literal notranslate"><span class="pre">Firmware</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Currently installed firmware used by the device.
|
||
If None firmware is unknown.</p></li>
|
||
<li><p><strong>used_by_vsan</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Shows whether the device is part of VSAN cluster or not.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Reports">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">Reports</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Reports" 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 download information generated from the
|
||
hardware compatibility feature residing on the vCenter Appliance.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Reports.Location">
|
||
<em class="property">class </em><code class="sig-name descname">Location</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">report_token</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Reports.Location" 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">Reports.Location</span></code> class contains the URI location to download
|
||
generated compatibility report, as well as a token required (as a header on
|
||
the HTTP GET request) to get the report. The validity of the token is 5
|
||
minutes. After the token expires, any attempt to call the URI with said
|
||
token will fail.</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>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Compatibility report download URL.</p></li>
|
||
<li><p><strong>report_token</strong> (<a class="reference internal" href="#com.vmware.esx.hcl_client.Reports.Token" title="com.vmware.esx.hcl_client.Reports.Token"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Token</span></code></a>) – Information about the token required in the HTTP GET request to
|
||
download the compatibility report.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Reports.Token">
|
||
<em class="property">class </em><code class="sig-name descname">Token</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">token</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">expiry</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Reports.Token" 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">Reports.Token</span></code> class contains information about the token required
|
||
to be passed in the HTTP header in the HTTP GET request to generate the
|
||
report.</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>token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A one-time, short-lived token required in the HTTP header of the
|
||
request to the url. This token needs to be passed in as a header
|
||
with the name “session-id”.</p></li>
|
||
<li><p><strong>expiry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Expiry time of the token</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="com.vmware.esx.hcl_client.Reports.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">report</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Reports.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the location <a class="reference internal" href="#com.vmware.esx.hcl_client.Reports.Location" title="com.vmware.esx.hcl_client.Reports.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Location</span></code></a> information for
|
||
downloading a compatibility report.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>report</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – identifier of hardware compatiblity report to be downloaded.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hcl.resources.CompatibilityReport</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.hcl_client.Reports.Location" title="com.vmware.esx.hcl_client.Reports.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Location</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">Reports.Location</span></code> class which includes the URI to file, short
|
||
lived token and expiry of the token in the
|
||
<a class="reference internal" href="#com.vmware.esx.hcl_client.Reports.Location" title="com.vmware.esx.hcl_client.Reports.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Reports.Location</span></code></a> object.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if there is no report for the given id.</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
||
if the caller is not authenticated.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceInaccessible" title="com.vmware.vapi.std.errors_client.ResourceInaccessible"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceInaccessible</span></code></a>
|
||
if the vCenter this API is executed on is not part of the Customer
|
||
Experience Improvement Program (CEIP).</p>
|
||
</dd>
|
||
<dt class="field-odd">Raise</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
If there is some unknown error. The accompanying error message will
|
||
give more details about the failure.</p>
|
||
</dd>
|
||
<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>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.Server">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">Server</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_series</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cpu_features</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">bios</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_client.Server" 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">Server</span></code> class contains attributes describing information about a
|
||
server.</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_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the server model.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the vendor.</p></li>
|
||
<li><p><strong>cpu_series</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The CPU series name.</p></li>
|
||
<li><p><strong>cpu_features</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The current CPU features.</p></li>
|
||
<li><p><strong>bios</strong> (<a class="reference internal" href="#com.vmware.esx.hcl_client.Firmware" title="com.vmware.esx.hcl_client.Firmware"><code class="xref py py-class docutils literal notranslate"><span class="pre">Firmware</span></code></a>) – Currently installed BIOS of the server.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hcl_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hcl_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hcl_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.hosts_client">
|
||
<span id="com-vmware-esx-hosts-client-module"></span><h2>com.vmware.esx.hosts_client module<a class="headerlink" href="#module-com.vmware.esx.hosts_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.hosts_client</span></code> module provides classes to manage ESX host.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hosts_client.AddOnInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hosts_client.</code><code class="sig-name descname">AddOnInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts_client.AddOnInfo" 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">AddOnInfo</span></code> class contains attributes that describe a specific OEM
|
||
customization add-on.</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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the add-on
|
||
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.hosts.add_on</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.hosts.add_on</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the add-on</p></li>
|
||
<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 OEM add-on.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the OEM add-on.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hosts_client.BaseImageInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hosts_client.</code><code class="sig-name descname">BaseImageInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">release_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts_client.BaseImageInfo" 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">BaseImageInfo</span></code> class contains attributes that describe a specific
|
||
ESX base-image.</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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the base-image.
|
||
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.hosts.base_image</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.hosts.base_image</span></code>.</p></li>
|
||
<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 base-image.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the base-image.</p></li>
|
||
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the base-image.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hosts_client.ComponentInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hosts_client.</code><code class="sig-name descname">ComponentInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts_client.ComponentInfo" 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">ComponentInfo</span></code> class contains attributes that describe a specific
|
||
component version in a 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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component.</p></li>
|
||
<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 component.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the component.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the component.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hosts_client.SoftwareInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hosts_client.</code><code class="sig-name descname">SoftwareInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">base_image</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">add_on</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">solutions</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts_client.SoftwareInfo" 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">SoftwareInfo</span></code> class contains attributes that describe desired
|
||
software specification for an ESX host.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>base_image</strong> (<a class="reference internal" href="#com.vmware.esx.hosts_client.BaseImageInfo" title="com.vmware.esx.hosts_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageInfo</span></code></a>) – Base image of the ESX.</p></li>
|
||
<li><p><strong>add_on</strong> (<a class="reference internal" href="#com.vmware.esx.hosts_client.AddOnInfo" title="com.vmware.esx.hosts_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – OEM customization on top of given base-image. The components in
|
||
this customization override the components in the base base-image.
|
||
If None, no OEM customization will be applied.</p></li>
|
||
<li><p><strong>components</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.hosts_client.ComponentInfo" title="com.vmware.esx.hosts_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)) – Map of components in an ESX image. The key is the component name
|
||
and value is the information about specific version of the
|
||
component.
|
||
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">com.vmware.esx.hosts.component</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">com.vmware.esx.hosts.component</span></code>.</p></li>
|
||
<li><p><strong>solutions</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.hosts_client.SolutionInfo" title="com.vmware.esx.hosts_client.SolutionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionInfo</span></code></a>) – Map of software solutions in an ESX image. The key is the solution
|
||
name and value is the specification detailing components registered
|
||
by that solution.
|
||
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">com.vmware.esx.hosts.solution</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">com.vmware.esx.hosts.solution</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hosts_client.SolutionInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hosts_client.</code><code class="sig-name descname">SolutionInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts_client.SolutionInfo" 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">SolutionInfo</span></code> class contains attributes that describe solution
|
||
registered in the 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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the solution.</p></li>
|
||
<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 solution.</p></li>
|
||
<li><p><strong>components</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.hosts_client.ComponentInfo" title="com.vmware.esx.hosts_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a>) – Components registered by the solution.
|
||
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">com.vmware.esx.hosts.component</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">com.vmware.esx.hosts.component</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.hosts_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.hosts_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.hosts_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.esx.settings_client">
|
||
<span id="com-vmware-esx-settings-client-module"></span><h2>com.vmware.esx.settings_client module<a class="headerlink" href="#module-com.vmware.esx.settings_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client</span></code> module provides classes to manage ESX
|
||
settings.</p>
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.AddOnCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">AddOnCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.AddOnCompliance" 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">AddOnCompliance</span></code> class contains information that describe the
|
||
compliance of the OEM add-on with respect to the add-on 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_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the OEM add-on.</p></li>
|
||
<li><p><strong>current</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.AddOnInfo" title="com.vmware.esx.settings_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Current OEM add-on present on the host.
|
||
None if OEM add-on is not present on the host.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.AddOnInfo" title="com.vmware.esx.settings_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Target OEM add-on present in the software specification.
|
||
None if OEM add-on is not present in the software specification.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications describing the compliance result.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.AddOnDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">AddOnDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.AddOnDetails" 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">AddOnDetails</span></code> class contains information that provide more details
|
||
about the add-on from the depot.</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 OEM add-on.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the OEM add-on.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.AddOnInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">AddOnInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.AddOnInfo" 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">AddOnInfo</span></code> class contains information that describe a specific OEM
|
||
customization add-on.</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>details</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.AddOnDetails" title="com.vmware.esx.settings_client.AddOnDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the add-on.
|
||
None if add-on is not present in the depot.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the add-on</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the add-on</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.AddOnSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">AddOnSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.AddOnSpec" 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">AddOnSpec</span></code> class contains attributes that describe a specific OEM
|
||
customization add-on.</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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the add-on</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the add-on</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.BaseImageCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">BaseImageCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.BaseImageCompliance" 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">BaseImageCompliance</span></code> class contains information that describe the
|
||
compliance of ESX base image with respect to the base image 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_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the base image.</p></li>
|
||
<li><p><strong>current</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.BaseImageInfo" title="com.vmware.esx.settings_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageInfo</span></code></a>) – Current base image information on the host.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.BaseImageInfo" title="com.vmware.esx.settings_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageInfo</span></code></a>) – Target base image information present in the software
|
||
specification.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications describing the compliance result.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.BaseImageDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">BaseImageDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">release_date</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.BaseImageDetails" 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">BaseImageDetails</span></code> class contains information that provide more
|
||
details about the base image from the depot.</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 base-image.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the base-image.</p></li>
|
||
<li><p><strong>release_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Release date of the base-image.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.BaseImageInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">BaseImageInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.BaseImageInfo" 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">BaseImageInfo</span></code> class contains information that describe a specific
|
||
ESX base-image.</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>details</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.BaseImageDetails" title="com.vmware.esx.settings_client.BaseImageDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the base-image.
|
||
None if base-image is not present in the depot.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the base-image</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.BaseImageSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">BaseImageSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.BaseImageSpec" 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">BaseImageSpec</span></code> class contains attributes that describe a specific
|
||
ESX base-image.</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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the base-image</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ClusterCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ClusterCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">impact</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scan_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compliant_hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">non_compliant_hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">incompatible_hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">unavailable_hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hosts</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">host_info</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ClusterCompliance" 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">ClusterCompliance</span></code> class contains attributes to describe the
|
||
compliance result of a 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"><ul class="simple">
|
||
<li><p><strong>impact</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComplianceImpact" title="com.vmware.esx.settings_client.ComplianceImpact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceImpact</span></code></a>) – Overall impact.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Overall compliance state of the host.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications returned by the scan operation.</p></li>
|
||
<li><p><strong>scan_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Scan completion 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>) – Identifier of the commit on which the scan is run to generate this
|
||
result.
|
||
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>.
|
||
None if operation is performed on a draft.</p></li>
|
||
<li><p><strong>compliant_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>) – Identifiers of compliant hosts.
|
||
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>non_compliant_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>) – Identifiers of non-compliant hosts.
|
||
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>incompatible_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>) – Identifiers of incompatible hosts.
|
||
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>unavailable_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>) – Identifiers of unavailable hosts. There will not be compliance
|
||
details for these hosts in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ClusterCompliance.hosts</span></code>.
|
||
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>hosts</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_client.HostCompliance" title="com.vmware.esx.settings_client.HostCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostCompliance</span></code></a>) – Mapping from host identifier to the compliance information for the
|
||
host.
|
||
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_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.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostInfo</span></code></a>) – Auxillary information about the hosts. This gives some additional
|
||
information about the hosts referenced in this result.
|
||
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_client.ComplianceImpact">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComplianceImpact</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceImpact" 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">ComplianceImpact</span></code> class contains information about the impact of
|
||
applying the target state in case of non compliance.</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_client.ComplianceImpact" title="com.vmware.esx.settings_client.ComplianceImpact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceImpact</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceImpact.MAINTENANCE_MODE_REQUIRED">
|
||
<code class="sig-name descname">MAINTENANCE_MODE_REQUIRED</code><em class="property"> = ComplianceImpact(string='MAINTENANCE_MODE_REQUIRED')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceImpact.MAINTENANCE_MODE_REQUIRED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Host requires maintenance mode to reach this target state.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceImpact.NO_IMPACT">
|
||
<code class="sig-name descname">NO_IMPACT</code><em class="property"> = ComplianceImpact(string='NO_IMPACT')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceImpact.NO_IMPACT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Host has no impact.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceImpact.REBOOT_REQUIRED">
|
||
<code class="sig-name descname">REBOOT_REQUIRED</code><em class="property"> = ComplianceImpact(string='REBOOT_REQUIRED')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceImpact.REBOOT_REQUIRED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Host requires reboot to reach this target state.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceImpact.UNKNOWN">
|
||
<code class="sig-name descname">UNKNOWN</code><em class="property"> = ComplianceImpact(string='UNKNOWN')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceImpact.UNKNOWN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Impact is unknown.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceStatus">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComplianceStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_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_client.ComplianceStatus" title="com.vmware.esx.settings_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_client.ComplianceStatus.COMPLIANT">
|
||
<code class="sig-name descname">COMPLIANT</code><em class="property"> = ComplianceStatus(string='COMPLIANT')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceStatus.COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target version is same as current version.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceStatus.INCOMPATIBLE">
|
||
<code class="sig-name descname">INCOMPATIBLE</code><em class="property"> = ComplianceStatus(string='INCOMPATIBLE')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceStatus.INCOMPATIBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target state cannot be applied due to conflict or missing dependencies or
|
||
the target state is lesser than the current version.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceStatus.NON_COMPLIANT">
|
||
<code class="sig-name descname">NON_COMPLIANT</code><em class="property"> = ComplianceStatus(string='NON_COMPLIANT')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceStatus.NON_COMPLIANT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Target version is greater than current version.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComplianceStatus.UNAVAILABLE">
|
||
<code class="sig-name descname">UNAVAILABLE</code><em class="property"> = ComplianceStatus(string='UNAVAILABLE')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComplianceStatus.UNAVAILABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Drift check failed due to unknown error or check hasn’t happened yet and
|
||
results are not available.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ComponentCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComponentCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current_source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target_source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentCompliance" 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">ComponentCompliance</span></code> class contains information that describe the
|
||
compliance of a component 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_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the component.</p></li>
|
||
<li><p><strong>current</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Current version of the component present on the host.
|
||
None if component is not present on the host.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Target version of the component present in the software
|
||
specification.
|
||
None if component is not present in the software specification.</p></li>
|
||
<li><p><strong>current_source</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentSource" title="com.vmware.esx.settings_client.ComponentSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentSource</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Source of the component on the host.
|
||
None if component is not present on the host.</p></li>
|
||
<li><p><strong>target_source</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentSource" title="com.vmware.esx.settings_client.ComponentSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentSource</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Source of the component in the software specification.
|
||
None if component is not present in the software specification.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications describing the compliance result.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ComponentDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComponentDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentDetails" 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">ComponentDetails</span></code> class contains information that provide more
|
||
details about the component from the depot.</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 component.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the component.</p></li>
|
||
<li><p><strong>display_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>) – Human readable version of the component.
|
||
None if no version is provided for the component.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ComponentInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComponentInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentInfo" 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">ComponentInfo</span></code> class contains information that describe a specific
|
||
component version in a 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>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>) – Version of the component.
|
||
None if version is not specified.</p></li>
|
||
<li><p><strong>details</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentDetails" title="com.vmware.esx.settings_client.ComponentDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the component.
|
||
None if component is not present in the depot.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ComponentOverrideInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComponentOverrideInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">note</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentOverrideInfo" 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">ComponentOverrideInfo</span></code> class contains fields that describe how the
|
||
component was overridden.</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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component override.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the component override.</p></li>
|
||
<li><p><strong>source</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentSource" title="com.vmware.esx.settings_client.ComponentSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentSource</span></code></a>) – Source of the component override.</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>) – Note explaining the override.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.ComponentSource">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">ComponentSource</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentSource" 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">ComponentSource</span></code> class contains the component’s source information.</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_client.ComponentSource" title="com.vmware.esx.settings_client.ComponentSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentSource</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComponentSource.ADD_ON">
|
||
<code class="sig-name descname">ADD_ON</code><em class="property"> = ComponentSource(string='ADD_ON')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentSource.ADD_ON" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Addon is the source for this component</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComponentSource.BASE_IMAGE">
|
||
<code class="sig-name descname">BASE_IMAGE</code><em class="property"> = ComponentSource(string='BASE_IMAGE')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentSource.BASE_IMAGE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Base image is the source for this component</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComponentSource.HARDWARE_SUPPORT_PACKAGE">
|
||
<code class="sig-name descname">HARDWARE_SUPPORT_PACKAGE</code><em class="property"> = ComponentSource(string='HARDWARE_SUPPORT_PACKAGE')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentSource.HARDWARE_SUPPORT_PACKAGE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hardware Support Package (HSP) is the source for this component</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComponentSource.SOLUTION">
|
||
<code class="sig-name descname">SOLUTION</code><em class="property"> = ComponentSource(string='SOLUTION')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentSource.SOLUTION" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Solution is the source for this component</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.ComponentSource.USER">
|
||
<code class="sig-name descname">USER</code><em class="property"> = ComponentSource(string='USER')</em><a class="headerlink" href="#com.vmware.esx.settings_client.ComponentSource.USER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>User is the source for this component</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.Depots">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">Depots</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.Depots" 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">Depots</span></code> class provides methods to manage Software Depots used during
|
||
ESX lifecycle management.</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 method">
|
||
<dt id="com.vmware.esx.settings_client.Depots.sync_task">
|
||
<code class="sig-name descname">sync_task</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.Depots.sync_task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Syncs the metadata from the currently configured online or umds depots.
|
||
If any umds depot is set, then metadata is downloaded from that depot
|
||
else metadata is downloaded from the online depots. 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">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.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.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
|
||
if the service is timed out.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
||
if there is some unknown internal error. The accompanying error
|
||
message will give more details about the failure.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.EffectiveComponentDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">EffectiveComponentDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">note</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">overridden_components</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.EffectiveComponentDetails" 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">EffectiveComponentDetails</span></code> class contains information that provide
|
||
more details about the component from the depot.</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 component.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human readable version of the component.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the component.</p></li>
|
||
<li><p><strong>source</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComponentSource" title="com.vmware.esx.settings_client.ComponentSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentSource</span></code></a>) – Final effective source of the component.</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Note assosicated with this component.
|
||
If None, note is present for this component.</p></li>
|
||
<li><p><strong>overridden_components</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_client.ComponentOverrideInfo" title="com.vmware.esx.settings_client.ComponentOverrideInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentOverrideInfo</span></code></a>) – List of other component versions present in base-image, add-ons or
|
||
solutions that this component is overriding. For example, if a
|
||
component version-1 was implicitly present in the base-image, but
|
||
user wants it to be changed to version-2. In that case,
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">EffectiveComponentDetails.source</span></code> would be USER and there
|
||
will be one entry in this list indicating base-image component
|
||
version-1 is being overridden.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.EffectiveComponentInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">EffectiveComponentInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.EffectiveComponentInfo" 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">EffectiveComponentInfo</span></code> class contains information that describe a
|
||
component and how that component appeared in the 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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the component.</p></li>
|
||
<li><p><strong>details</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.EffectiveComponentDetails" title="com.vmware.esx.settings_client.EffectiveComponentDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">EffectiveComponentDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the effective component.
|
||
None if component is not present in the depot.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleClass">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareModuleClass</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleClass" 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">HardwareModuleClass</span></code> class contains the module’s source information.</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_client.HardwareModuleClass" title="com.vmware.esx.settings_client.HardwareModuleClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareModuleClass</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleClass.OTHER">
|
||
<code class="sig-name descname">OTHER</code><em class="property"> = HardwareModuleClass(string='OTHER')</em><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleClass.OTHER" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Other (non-PCI) hardware</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleClass.PCI_DEVICE">
|
||
<code class="sig-name descname">PCI_DEVICE</code><em class="property"> = HardwareModuleClass(string='PCI_DEVICE')</em><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleClass.PCI_DEVICE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PCI device</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleClass.SYSTEM_BIOS">
|
||
<code class="sig-name descname">SYSTEM_BIOS</code><em class="property"> = HardwareModuleClass(string='SYSTEM_BIOS')</em><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleClass.SYSTEM_BIOS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>System BIOS</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareModuleDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component_class</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleDetails" 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">HardwareModuleDetails</span></code> class contains information that provide more
|
||
details about the a hardware module (e.g. BIOS, 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>component_class</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.HardwareModuleClass" title="com.vmware.esx.settings_client.HardwareModuleClass"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareModuleClass</span></code></a>) – Class of module (BIOS, PCI Device, non-PCI hardware, etc.)</p></li>
|
||
<li><p><strong>description</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>) – Descipription of the hardware module (e.g. “System BIOS” or
|
||
“Frobozz 100Gb NIC”).
|
||
None if description is not specified.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareModuleFirmwareCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance" 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">HardwareModuleFirmwareCompliance</span></code> class contains information that
|
||
describe the compliance of firmware of a particular hardware module (e.g.
|
||
BIOS, PCI device) on the host with respect to the firmware present in the
|
||
target Hardware Support Package (HSP) 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_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the hardware module’s firmware.</p></li>
|
||
<li><p><strong>details</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.HardwareModuleDetails" title="com.vmware.esx.settings_client.HardwareModuleDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareModuleDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional details about the hardware module itself
|
||
None if no further info was provided by HSM.</p></li>
|
||
<li><p><strong>current</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.HardwareModuleFirmwareInfo" title="com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareModuleFirmwareInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Current version of the firmware present on the host hardware
|
||
module.
|
||
None if version of firmware on the hardware module on the host
|
||
cannot be determined.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.HardwareModuleFirmwareInfo" title="com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareModuleFirmwareInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Target version of the firmware present in the Hardware Support
|
||
Package (HSP).
|
||
None if component is not present in the software specification.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications describing the compliance result.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareModuleFirmwareInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareModuleFirmwareInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareModuleFirmwareInfo" 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">HardwareModuleFirmwareInfo</span></code> class contains information to describe
|
||
the firmware on a hardware component or module (e.g. BIOS, 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"><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the hardware module firmware.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareSupportInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareSupportInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">packages</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareSupportInfo" 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">HardwareSupportInfo</span></code> class contains information to describe the
|
||
desired Hardware Support Package (HSP) configured for a 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>packages</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_client.HardwareSupportPackageInfo" title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareSupportPackageInfo</span></code></a>) – Map of Hardware Support Packages (HSPs) for the cluster. The key is
|
||
the Hardware Support Manager (HSM) identifier and the value is the
|
||
specification detailing the HSP configured for that HSM.
|
||
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">com.vmware.esx.setting.hardware_support.manager</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">com.vmware.esx.setting.hardware_support.manager</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareSupportPackageCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareSupportPackageCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hardware_modules</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareSupportPackageCompliance" 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">HardwareSupportPackageCompliance</span></code> class contains information that
|
||
describe compliance of the Hardware Support Package (HSP) on the host with
|
||
respect to the Hardware support Package (HSP) present in the target
|
||
software image specification, if any.</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_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the Hardware Support Package (HSP).</p></li>
|
||
<li><p><strong>current</strong> (<a class="reference internal" href="#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">HardwareSupportPackageInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Current version of the Hardware Support Package present on the
|
||
host.
|
||
None if there is no known Hardware Support Package on the host.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#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">HardwareSupportPackageInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Target version of the Hardware Support Package present in the
|
||
software specification.
|
||
None if current desired image includes a Hardware Support Manager
|
||
(HSM) but no target Hardware Support Package (HSP).</p></li>
|
||
<li><p><strong>hardware_modules</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_client.HardwareModuleFirmwareCompliance" title="com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareModuleFirmwareCompliance</span></code></a>) – Compliance result for individual hardware module on the host. The
|
||
key is the module identifier and value is the
|
||
HardwareModuleFirmwareCompliance for the device. NOTE: if no
|
||
individual hardware module compliance is returned by the, Hardware
|
||
Support Manager (HSM), this map may have no entries even if
|
||
ComplianceStatus = NON_COMPLIANT
|
||
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">com.vmware.esx.setting.hardware_module</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">com.vmware.esx.setting.hardware_module</span></code>.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications describing the compliance result.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareSupportPackageInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareSupportPackageInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pkg</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareSupportPackageInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">HardwareSupportPackageInfo</span></code> class contains information to describe
|
||
the desired Hardware Support Package (HSP) configured for a single device
|
||
or distinct group of devices (typically the OEM’s, including BIOS and
|
||
device firmware).</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of Hardware Support Package (HSP) selected
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the Hardware Support Package (HSP) selected (e.g.
|
||
“20180128.1” or “v42”)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareSupportPackageSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareSupportPackageSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pkg</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareSupportPackageSpec" 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">HardwareSupportPackageSpec</span></code> class contains attributes to describe
|
||
the desired Hardware Support Package (HSP) configured for a single device
|
||
or distinct group of devices (typically the OEM’s, including BIOS, device
|
||
firmware and OEM-supplied driver or agent components).</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>pkg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Hardware Support Package (HSP) selected
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>. When methods
|
||
return a value of this class as a return value, the attribute will
|
||
be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.setting.hardware_support.package</span></code>.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Version of the Hardware Support Package (HSP) selected (e.g.
|
||
“20180128.1” or “v42”)
|
||
If None, the system will use an empty string as the version.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HardwareSupportSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HardwareSupportSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">packages</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HardwareSupportSpec" 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">HardwareSupportSpec</span></code> class contains attributes to describe the
|
||
desired Hardware Support Package (HSP) configured for a 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>packages</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_client.HardwareSupportPackageSpec" title="com.vmware.esx.settings_client.HardwareSupportPackageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareSupportPackageSpec</span></code></a>) – Map of Hardware Support Packages (HSPs) for the cluster. The key is
|
||
the Hardware Support Manager (HSM) name and the value is the
|
||
specification detailing the HSP configured for that HSM.
|
||
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">com.vmware.esx.setting.hardware_support.manager</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">com.vmware.esx.setting.hardware_support.manager</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HostCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HostCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">impact</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">scan_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">commit</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">base_image</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">add_on</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hardware_support</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">solutions</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HostCompliance" 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">HostCompliance</span></code> class contains information to describe the
|
||
compliance result of a host with respect to given 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>impact</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComplianceImpact" title="com.vmware.esx.settings_client.ComplianceImpact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceImpact</span></code></a>) – Overall impact.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Overall compliance state of the host.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications returned by the scan operation.</p></li>
|
||
<li><p><strong>scan_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Scan completion 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>) – Identifier of the commit on which the scan is run to generate this
|
||
result.
|
||
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>.
|
||
None if operation is performed on a working copy document.</p></li>
|
||
<li><p><strong>base_image</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.BaseImageCompliance" title="com.vmware.esx.settings_client.BaseImageCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageCompliance</span></code></a>) – Compliance result for the base image.</p></li>
|
||
<li><p><strong>add_on</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.AddOnCompliance" title="com.vmware.esx.settings_client.AddOnCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnCompliance</span></code></a>) – Compliance result for the OEM add-on.</p></li>
|
||
<li><p><strong>hardware_support</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_client.HardwareSupportPackageCompliance" title="com.vmware.esx.settings_client.HardwareSupportPackageCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareSupportPackageCompliance</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Compliance result for hardware support (both Hardware Support
|
||
Package or HSP and individual hardware module firmware) for every
|
||
HSP configured, keyed by Hardware Support Manager (HSM).
|
||
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">com.vmware.esx.setting.hardware_support.manager</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">com.vmware.esx.setting.hardware_support.manager</span></code>.
|
||
This attribute will be None or contain an empty map if operation is
|
||
performed on an image whose <code class="docutils literal notranslate"><span class="pre">SoftwareSpec</span></code> does not have a value
|
||
for its <code class="docutils literal notranslate"><span class="pre">hardwareSupport</span></code> attribute.</p></li>
|
||
<li><p><strong>components</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_client.ComponentCompliance" title="com.vmware.esx.settings_client.ComponentCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentCompliance</span></code></a>) – Compliance result for all the effective components and all the
|
||
components present on the host. The key is the component name and
|
||
value is the ComponentCompliance.
|
||
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">com.vmware.esx.settings.component</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">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
<li><p><strong>solutions</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_client.SolutionCompliance" title="com.vmware.esx.settings_client.SolutionCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionCompliance</span></code></a>) – Compliance result for solutions. The key is the solution name and
|
||
value is the SolutionCompliance.
|
||
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">com.vmware.esx.settings.solution</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">com.vmware.esx.settings.solution</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.HostInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">HostInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.HostInfo" 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">HostInfo</span></code> class contains attributes to describe some details
|
||
regarding a host in the inventory.</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>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the host.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.Notification">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">Notification</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resolution</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.Notification" 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">Notification</span></code> class contains attributes to describe any
|
||
info/warning/error messages that Tasks can raise.</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>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The notification id.</p></li>
|
||
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The time the notification was raised/found.</p></li>
|
||
<li><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>) – The notification message.</p></li>
|
||
<li><p><strong>resolution</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The resolution message, if any.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is a resolution available for this
|
||
notification.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.Notifications">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">Notifications</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">info</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">warnings</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">errors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.Notifications" 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">Notifications</span></code> class contains info/warning/error messages that can
|
||
be reported be the task.</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>info</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_client.Notification" title="com.vmware.esx.settings_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Info notification messages reported.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an info was reported by the task.</p></li>
|
||
<li><p><strong>warnings</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_client.Notification" title="com.vmware.esx.settings_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Warning notification messages reported.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an warning was reported by the task.</p></li>
|
||
<li><p><strong>errors</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_client.Notification" title="com.vmware.esx.settings_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">Notification</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error notification messages reported.
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if an error was reported by the task.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SoftwareInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SoftwareInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">base_image</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">add_on</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">solutions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hardware_support</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SoftwareInfo" 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">SoftwareInfo</span></code> class contains information that describes the desired
|
||
software specification for an ESX host.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>base_image</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.BaseImageInfo" title="com.vmware.esx.settings_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageInfo</span></code></a>) – Base image of the ESX.</p></li>
|
||
<li><p><strong>add_on</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.AddOnInfo" title="com.vmware.esx.settings_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – OEM customization on top of given base-image. The components in
|
||
this customization override the components in the base base-image.
|
||
If None, no OEM customization will be applied.</p></li>
|
||
<li><p><strong>components</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_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a>) – Information about the components in the software specification.
|
||
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">com.vmware.esx.settings.component</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">com.vmware.esx.settings.component</span></code>.</p></li>
|
||
<li><p><strong>solutions</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_client.SolutionInfo" title="com.vmware.esx.settings_client.SolutionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionInfo</span></code></a>) – Information about the solutions in the software specification.
|
||
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">com.vmware.esx.settings.solution</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">com.vmware.esx.settings.solution</span></code>.</p></li>
|
||
<li><p><strong>hardware_support</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.HardwareSupportInfo" title="com.vmware.esx.settings_client.HardwareSupportInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareSupportInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about the Hardware Support Packages (HSP) configured.
|
||
If None, no Hardware Support Package (HSP) is specified for the
|
||
cluster.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SoftwareSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SoftwareSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">base_image</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">add_on</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">solutions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hardware_support</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SoftwareSpec" 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">SoftwareSpec</span></code> class contains attributes that describe desired
|
||
software specification for an ESX host.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>base_image</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.BaseImageSpec" title="com.vmware.esx.settings_client.BaseImageSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseImageSpec</span></code></a>) – Base image of the ESX.</p></li>
|
||
<li><p><strong>add_on</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.AddOnSpec" title="com.vmware.esx.settings_client.AddOnSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AddOnSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – OEM customization on top of given base-image. The components in
|
||
this customization override the components in the base base-image.
|
||
If None, no OEM customization will be applied.</p></li>
|
||
<li><p><strong>components</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">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>)) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional components which should be part of the software
|
||
specification. If value is not given for a particular component
|
||
then version for that component will be picked from the
|
||
constraints. These override the components present in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">SoftwareSpec.add_on</span></code> and <code class="xref py py-attr docutils literal notranslate"><span class="pre">SoftwareSpec.base_image</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">com.vmware.esx.settings.component</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">com.vmware.esx.settings.component</span></code>.
|
||
If None, no additional components will be installed.</p></li>
|
||
<li><p><strong>solutions</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_client.SolutionSpec" title="com.vmware.esx.settings_client.SolutionSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionSpec</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Mapping from solution identifier to the solution specification. The
|
||
key is the solution name and the value is the specification
|
||
detailing components registered by that solution.
|
||
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">com.vmware.esx.settings.solution</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">com.vmware.esx.settings.solution</span></code>.
|
||
If None, no solutions will be part of the software specification.</p></li>
|
||
<li><p><strong>hardware_support</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.HardwareSupportSpec" title="com.vmware.esx.settings_client.HardwareSupportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">HardwareSupportSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about the Hardware Support Package (HSP) configured in
|
||
the software specification.
|
||
If None or empty, no firmware compliance checking or remediation
|
||
will be done.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SolutionCompliance">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SolutionCompliance</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SolutionCompliance" 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">SolutionCompliance</span></code> class contains information that describe the
|
||
compliance result of a host with respect to given solution 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_client.ComplianceStatus" title="com.vmware.esx.settings_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – Compliance status of the solution.</p></li>
|
||
<li><p><strong>current</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.SolutionInfo" title="com.vmware.esx.settings_client.SolutionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Current solution present on the host.
|
||
None if the solution is not present on the host.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.SolutionInfo" title="com.vmware.esx.settings_client.SolutionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Target solution present in the software specification.
|
||
None if solution is not present in the software specification.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a>) – Notifications describing the compliance result.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SolutionComponentDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SolutionComponentDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vendor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SolutionComponentDetails" 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">SolutionComponentDetails</span></code> class contains information that provide
|
||
more details about component registered by the solution from depot.</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>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
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.component</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.component</span></code>.</p></li>
|
||
<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 component.</p></li>
|
||
<li><p><strong>display_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>) – Human readable version of the component.
|
||
None if no version is provided for the component.</p></li>
|
||
<li><p><strong>vendor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Vendor of the component.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SolutionComponentSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SolutionComponentSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">component</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SolutionComponentSpec" 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">SolutionComponentSpec</span></code> class contains attributes that describe a
|
||
component registered by a software solution.</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>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
|
||
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.component</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.component</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SolutionDetails">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SolutionDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">display_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">display_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SolutionDetails" 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">SolutionDetails</span></code> class contains information that provide more
|
||
details about the solution from the depot.</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 solution.</p></li>
|
||
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display version of the solution.</p></li>
|
||
<li><p><strong>components</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_client.SolutionComponentDetails" title="com.vmware.esx.settings_client.SolutionComponentDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionComponentDetails</span></code></a>) – Components registered by the solution. If the component is not
|
||
present in the depot, then corresponding details are absent from
|
||
the list.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SolutionInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SolutionInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SolutionInfo" 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">SolutionInfo</span></code> class contains information that describe solution
|
||
registered in the 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>details</strong> (<a class="reference internal" href="#com.vmware.esx.settings_client.SolutionDetails" title="com.vmware.esx.settings_client.SolutionDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the solution from the depot.
|
||
None if solution is not present in the depot.</p></li>
|
||
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the solution.</p></li>
|
||
<li><p><strong>components</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_client.SolutionComponentSpec" title="com.vmware.esx.settings_client.SolutionComponentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionComponentSpec</span></code></a>) – Components registered by the solution.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.SolutionSpec">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">SolutionSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">components</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.SolutionSpec" 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">SolutionSpec</span></code> class contains attributes that describe solution
|
||
registered in the 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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version of the solution.</p></li>
|
||
<li><p><strong>components</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_client.SolutionComponentSpec" title="com.vmware.esx.settings_client.SolutionComponentSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SolutionComponentSpec</span></code></a>) – Components registered by the solution.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="com.vmware.esx.settings_client.StubFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_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_client.TaskInfo">
|
||
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings_client.</code><code class="sig-name descname">TaskInfo</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subtasks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">notifications</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">result</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_update_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">description</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">service</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">operation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">target</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cancelable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings_client.TaskInfo" 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">TaskInfo</span></code> class contains information about a task and its subtasks
|
||
of which it consists.</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>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>) – Progress of the operation.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">#status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>subtasks</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_client.TaskInfo" title="com.vmware.esx.settings_client.TaskInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskInfo</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about the subtasks that this task contains.
|
||
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">com.vmware.cis.task</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">com.vmware.cis.task</span></code>.
|
||
This attribute will be None if the task has no subtasks.</p></li>
|
||
<li><p><strong>notifications</strong> (<a class="reference internal" href="#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">Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications to the user
|
||
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the notifications were reported by this
|
||
particular task.</p></li>
|
||
<li><p><strong>result</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">DataValue</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task result.
|
||
This attribute will be None if the task has no result.</p></li>
|
||
<li><p><strong>last_update_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the task was last updated. This attribute was added in
|
||
vSphere API 7.0.1.0.
|
||
This attribute is optional because it was added in a newer version
|
||
than its parent node.</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>) – Description of the operation associated with the task.</p></li>
|
||
<li><p><strong>service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service containing the operation.
|
||
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.vapi.service</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.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the operation associated with the task.
|
||
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.vapi.operation</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.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>parent</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>) – Parent of the current task.
|
||
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.cis.task</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.cis.task</span></code>.
|
||
This attribute will be None if the task has no parent.</p></li>
|
||
<li><p><strong>target</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID" title="com.vmware.vapi.std_client.DynamicID"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Identifier of the target created by the operation or an existing
|
||
one the operation performed on.
|
||
This attribute will be None if the operation has no target or
|
||
multiple targets.</p></li>
|
||
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation associated with the task.</p></li>
|
||
<li><p><strong>cancelable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag to indicate whether or not the operation can be cancelled. The
|
||
value may change as the operation progresses.</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Description of the error if the operation status is “FAILED”.
|
||
If None the description of why the operation failed will be
|
||
included in the result of the operation (see
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Info.result</span></code>).</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 is started.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.RUNNING" title="com.vmware.cis.task_client.Status.RUNNING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.RUNNING</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.BLOCKED" title="com.vmware.cis.task_client.Status.BLOCKED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.BLOCKED</span></code></a>,
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a>, or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</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 is completed.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED" title="com.vmware.cis.task_client.Status.SUCCEEDED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
|
||
<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status.FAILED" title="com.vmware.cis.task_client.Status.FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status.FAILED</span></code></a>.</p></li>
|
||
<li><p><strong>user</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>) – Name of the user who performed the operation.
|
||
This attribute will be None if the operation is performed by the
|
||
system.</p></li>
|
||
</ul>
|
||
</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.hcl.html" class="btn btn-neutral float-right" title="com.vmware.esx.hcl package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.content.type.ovf.html" class="btn btn-neutral float-left" title="com.vmware.content.type.ovf package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
|
||
© Copyright 2020, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||
|
||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |