mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
829 lines
83 KiB
HTML
829 lines
83 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
<html class="writer-html5" lang="en" >
|
|||
|
<head>
|
|||
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
|||
|
|
|||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
<title>com.vmware.esx.settings.hosts.software package — vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
|
|||
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
<!--[if lt IE 9]>
|
|||
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
<![endif]-->
|
|||
|
|
|||
|
<script src="_static/jquery.js"></script>
|
|||
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|||
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|||
|
<script src="_static/doctools.js"></script>
|
|||
|
<script src="_static/sphinx_highlight.js"></script>
|
|||
|
<script src="_static/js/theme.js"></script>
|
|||
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
<link rel="next" title="com.vmware.esx.settings.hosts.software.drafts package" href="com.vmware.esx.settings.hosts.software.drafts.html" />
|
|||
|
<link rel="prev" title="com.vmware.esx.settings.hosts.policies package" href="com.vmware.esx.settings.hosts.policies.html" />
|
|||
|
</head>
|
|||
|
|
|||
|
<body class="wy-body-for-nav">
|
|||
|
<div class="wy-grid-for-nav">
|
|||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
<div class="wy-side-scroll">
|
|||
|
<div class="wy-side-nav-search" >
|
|||
|
|
|||
|
|
|||
|
|
|||
|
<a href="index.html" class="icon icon-home">
|
|||
|
vSphere Automation SDK for Python.
|
|||
|
</a>
|
|||
|
<div class="version">
|
|||
|
8.0.3.0
|
|||
|
</div>
|
|||
|
<div role="search">
|
|||
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
|
|||
|
<p class="caption" role="heading"><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.esx_client">com.vmware.esx_client module</a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_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>
|
|||
|
</ul>
|
|||
|
|
|||
|
</div>
|
|||
|
</div>
|
|||
|
</nav>
|
|||
|
|
|||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|||
|
<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="Page navigation">
|
|||
|
<ul class="wy-breadcrumbs">
|
|||
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|||
|
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
|
|||
|
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
|
|||
|
<li class="breadcrumb-item"><a href="com.vmware.esx.html">com.vmware.esx package</a></li>
|
|||
|
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a></li>
|
|||
|
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.hosts.html">com.vmware.esx.settings.hosts package</a></li>
|
|||
|
<li class="breadcrumb-item active">com.vmware.esx.settings.hosts.software package</li>
|
|||
|
<li class="wy-breadcrumbs-aside">
|
|||
|
<a href="_sources/com.vmware.esx.settings.hosts.software.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
</li>
|
|||
|
</ul>
|
|||
|
<hr/>
|
|||
|
</div>
|
|||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
<div itemprop="articleBody">
|
|||
|
|
|||
|
<section id="module-com.vmware.esx.settings.hosts.software">
|
|||
|
<span id="com-vmware-esx-settings-hosts-software-package"></span><h1>com.vmware.esx.settings.hosts.software package<a class="headerlink" href="#module-com.vmware.esx.settings.hosts.software" title="Permalink to this heading"></a></h1>
|
|||
|
<section id="subpackages">
|
|||
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
|
|||
|
<div class="toctree-wrapper compound">
|
|||
|
<ul>
|
|||
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html">com.vmware.esx.settings.hosts.software.drafts package</a><ul>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#submodules">Submodules</a></li>
|
|||
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#module-com.vmware.esx.settings.hosts.software.drafts.software_client">com.vmware.esx.settings.hosts.software.drafts.software_client module</a><ul>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn"><code class="docutils literal notranslate"><span class="pre">AddOn</span></code></a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">AddOn.RESOURCE_TYPE</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn.delete"><code class="docutils literal notranslate"><span class="pre">AddOn.delete()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn.get"><code class="docutils literal notranslate"><span class="pre">AddOn.get()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.AddOn.set"><code class="docutils literal notranslate"><span class="pre">AddOn.set()</span></code></a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage"><code class="docutils literal notranslate"><span class="pre">BaseImage</span></code></a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">BaseImage.RESOURCE_TYPE</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage.get"><code class="docutils literal notranslate"><span class="pre">BaseImage.get()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.BaseImage.set"><code class="docutils literal notranslate"><span class="pre">BaseImage.set()</span></code></a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components"><code class="docutils literal notranslate"><span class="pre">Components</span></code></a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">Components.RESOURCE_TYPE</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.UpdateSpec"><code class="docutils literal notranslate"><span class="pre">Components.UpdateSpec</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.delete"><code class="docutils literal notranslate"><span class="pre">Components.delete()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.get"><code class="docutils literal notranslate"><span class="pre">Components.get()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.list"><code class="docutils literal notranslate"><span class="pre">Components.list()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.set"><code class="docutils literal notranslate"><span class="pre">Components.set()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.Components.update"><code class="docutils literal notranslate"><span class="pre">Components.update()</span></code></a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.EffectiveComponents"><code class="docutils literal notranslate"><span class="pre">EffectiveComponents</span></code></a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.EffectiveComponents.list"><code class="docutils literal notranslate"><span class="pre">EffectiveComponents.list()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.EffectiveComponents.list_with_removed_components"><code class="docutils literal notranslate"><span class="pre">EffectiveComponents.list_with_removed_components()</span></code></a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.RemovedComponents"><code class="docutils literal notranslate"><span class="pre">RemovedComponents</span></code></a><ul>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.RemovedComponents.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.RESOURCE_TYPE</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.RemovedComponents.delete"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.delete()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.RemovedComponents.get"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.get()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.RemovedComponents.list"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.list()</span></code></a></li>
|
|||
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.RemovedComponents.set"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.set()</span></code></a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.hosts.software.drafts.html#com.vmware.esx.settings.hosts.software.drafts.software_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
</ul>
|
|||
|
</li>
|
|||
|
</ul>
|
|||
|
</div>
|
|||
|
</section>
|
|||
|
<section id="submodules">
|
|||
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
|||
|
</section>
|
|||
|
<section id="module-com.vmware.esx.settings.hosts.software.drafts_client">
|
|||
|
<span id="com-vmware-esx-settings-hosts-software-drafts-client-module"></span><h2>com.vmware.esx.settings.hosts.software.drafts_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hosts.software.drafts_client" title="Permalink to this heading"></a></h2>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.hosts.software.drafts_client</span></code> module provides
|
|||
|
classes to manage software drafts for ESX host.</p>
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.drafts_client.StubFactory">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hosts.software.drafts_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.drafts_client.StubFactory" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
|
|||
|
<p>Initialize StubFactoryBase</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></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>
|
|||
|
|
|||
|
</section>
|
|||
|
<section id="module-com.vmware.esx.settings.hosts.software.reports_client">
|
|||
|
<span id="com-vmware-esx-settings-hosts-software-reports-client-module"></span><h2>com.vmware.esx.settings.hosts.software.reports_client module<a class="headerlink" href="#module-com.vmware.esx.settings.hosts.software.reports_client" title="Permalink to this heading"></a></h2>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.hosts.software.reports_client</span></code> module provides
|
|||
|
classes to manage reports pertaining to the desired state software for
|
|||
|
standalone ESXi hosts.</p>
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hosts.software.reports_client.</span></span><span class="sig-name descname"><span class="pre">ApplyImpact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">ApplyImpact</span></code> class provides methods to get the impact of an apply
|
|||
|
method on a standalone ESXi host. This class was added in vSphere API
|
|||
|
8.0.0.1.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.HostImpact">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">HostImpact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">impact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.HostImpact" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">ApplyImpact.HostImpact</span></code> class contains attributes that describe the
|
|||
|
summary of how the standalone ESXi host will be impacted during an apply
|
|||
|
method. This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>impact</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.Impact" title="com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.Impact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyImpact.Impact</span></code></a>) – Impact of steps performed during the apply method. This attribute
|
|||
|
was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the commit on which the impact is generated. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
When clients pass a value of this class as a parameter, the
|
|||
|
attribute must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
this class as a return value, the attribute will be an identifier
|
|||
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.</p></li>
|
|||
|
<li><p><strong>host_info</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information of the host. This attribute was added in vSphere API
|
|||
|
8.0.0.1.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.Impact">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Impact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.Impact" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">ApplyImpact.Impact</span></code> class contains attributes that describe what the
|
|||
|
impact is of a particular step during the apply method. This class was
|
|||
|
added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Description of the impact. This attribute was added in vSphere API
|
|||
|
8.0.0.1.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py method">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.get">
|
|||
|
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.get" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Returns a summary of how a standalone ESXi host will be impacted during
|
|||
|
an apply method. The impact is generated from the compliance
|
|||
|
information obtained from
|
|||
|
<a class="reference internal" href="com.vmware.esx.settings.hosts.html#com.vmware.esx.settings.hosts.software_client.Compliance.get" title="com.vmware.esx.settings.hosts.software_client.Compliance.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.hosts.software_client.Compliance.get()</span></code></a>.
|
|||
|
This method was added in vSphere API 8.0.0.1.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The host identifier.
|
|||
|
The parameter must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.HostImpact" title="com.vmware.esx.settings.hosts.software.reports_client.ApplyImpact.HostImpact"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyImpact.HostImpact</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p>Summary of how hosts will be impacted during an apply method</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
If there is an unknown internal error. The accompanying error
|
|||
|
message will give more details about the failure.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
If there is no host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the system.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
If the host is not a vLCM managed standlone host.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise<span class="colon">:</span></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.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
|||
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
|||
|
requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hosts.software.reports_client.</span></span><span class="sig-name descname"><span class="pre">LastApplyResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastApplyResult</span></code> class provides methods to get the most recent
|
|||
|
available result of applying the desired software document to a standalone
|
|||
|
ESXi host. This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyResult">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ApplyResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyResult" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult</span></code> class contains attributes that describe
|
|||
|
the result of an apply method. This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus" title="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the status of the apply method. This attribute was added
|
|||
|
in vSphere API 8.0.0.1.
|
|||
|
None if the apply method is in progress.</p></li>
|
|||
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the commit used to fetch the desired software
|
|||
|
document to be applied to the standalone host. This attribute was
|
|||
|
added in vSphere API 8.0.0.1.
|
|||
|
When clients pass a value of this class as a parameter, the
|
|||
|
attribute must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
this class as a return value, the attribute will be an identifier
|
|||
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.</p></li>
|
|||
|
<li><p><strong>host_info</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information of the host to which the desired software document
|
|||
|
specified by the <code class="xref py py-attr docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult.commit</span></code> needs
|
|||
|
to be applied to. This attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications providing additional information for
|
|||
|
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.hosts_client.Software.apply()</span></code> method.
|
|||
|
These notifications are mutually exclusive with the notifications
|
|||
|
in <code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code>. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ApplyStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notifications</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code> class contains attributes that describe
|
|||
|
the status of an apply method. This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status" title="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status</span></code></a>) – The status of the method. This attribute was added in vSphere API
|
|||
|
8.0.0.1.</p></li>
|
|||
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method started. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method completed. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications providing additional information about the status of
|
|||
|
the method. This attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status</span></code> class contains the possible
|
|||
|
different status codes that can be returned while trying to apply the
|
|||
|
desired software specification to a standalone host. This enumeration was
|
|||
|
added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition note">
|
|||
|
<p class="admonition-title">Note</p>
|
|||
|
<p>This class represents an enumerated type in the interface language
|
|||
|
definition. The class contains class attributes which represent the
|
|||
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
the enumerated type may contain new values. To use new values of the
|
|||
|
enumerated type in communication with a server that supports the newer
|
|||
|
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.ERROR">
|
|||
|
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.ERROR" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The method encountered an unspecified error. This class attribute was added
|
|||
|
in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.OK">
|
|||
|
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.OK" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The method completed successfully. This class attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.SKIPPED">
|
|||
|
<span class="sig-name descname"><span class="pre">SKIPPED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='SKIPPED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.SKIPPED" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The method was skipped. This class attribute was added in vSphere API
|
|||
|
8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.TIMED_OUT">
|
|||
|
<span class="sig-name descname"><span class="pre">TIMED_OUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='TIMED_OUT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyStatus.Status.TIMED_OUT" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The method timed out. This class attribute was added in vSphere API
|
|||
|
8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py method">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.get">
|
|||
|
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.get" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Returns the most recent available result of applying the desired
|
|||
|
software document to the standalone ESXi host. This method was added in
|
|||
|
vSphere API 8.0.0.1.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the host identifier.
|
|||
|
The parameter must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyResult" title="com.vmware.esx.settings.hosts.software.reports_client.LastApplyResult.ApplyResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p>Most recent available result of applying the desired software
|
|||
|
document to the standalone ESXi host.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
If there is an unknown internal error. The accompanying error
|
|||
|
message will give more details about the failure.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
If there is no standalone host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the
|
|||
|
system or if there is no result associated with the host <code class="docutils literal notranslate"><span class="pre">host</span></code></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
If the host is not a vLCM managed standlone host.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise<span class="colon">:</span></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.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
|||
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
|||
|
requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hosts.software.reports_client.</span></span><span class="sig-name descname"><span class="pre">LastCheckResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult</span></code> class provides methods to get the most recent
|
|||
|
available result of the checks that have been run on the standalone host
|
|||
|
before the application of the desired software document to the host. This
|
|||
|
class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckInfo">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">originator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckInfo" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckInfo</span></code> class contains attributes that describe a
|
|||
|
particular check. This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>check</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The check identifier. This attribute was added in vSphere API
|
|||
|
8.0.0.1.</p></li>
|
|||
|
<li><p><strong>name</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The check name. This attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>description</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Human-readable check description. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>originator</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 service that performed the check. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.
|
|||
|
Only <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there is an originator available for this
|
|||
|
check.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckIssue">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckIssue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resolution</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckIssue" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<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 issue encountered. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.</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>) – Possible resolution for the issue. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.
|
|||
|
Can be left None if no meaningful resolution exists.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckResult">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity_result</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckResult" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckResult</span></code> class contains attributes that describe
|
|||
|
aggregated status of all checks performed. This class was added in vSphere
|
|||
|
API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a>) – Aggregated status from all checks performed. This attribute was
|
|||
|
added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation started. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the operation completed. This attribute was added in
|
|||
|
vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the commit on which checks have been run. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.
|
|||
|
When clients pass a value of this class as a parameter, the
|
|||
|
attribute must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>. When methods return a value of
|
|||
|
this class as a return value, the attribute will be an identifier
|
|||
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.</p></li>
|
|||
|
<li><p><strong>host_info</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information about the host for which checks have been requested to
|
|||
|
be run. This attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>entity_result</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult</span></code></a>) – List of <code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult</span></code> for all entities for
|
|||
|
which checks have been run. This attribute was added in vSphere API
|
|||
|
8.0.0.1.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckStatus">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_issues</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckStatus" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckStatus</span></code> class contains attributes that describe
|
|||
|
a check result. This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>check</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckInfo" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckInfo</span></code></a>) – Information about this check. This attribute was added in vSphere
|
|||
|
API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a>) – The status of this check. This attribute was added in vSphere API
|
|||
|
8.0.0.1.</p></li>
|
|||
|
<li><p><strong>check_issues</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckIssue" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckIssue"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckIssue</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The issues encountered while running this check. This attribute was
|
|||
|
added in vSphere API 8.0.0.1.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EntityCheckResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_statuses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult</span></code> class contains attributes that
|
|||
|
describe aggregated status of all checks performed on a specific entity.
|
|||
|
This class was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition tip">
|
|||
|
<p class="admonition-title">Tip</p>
|
|||
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
names.</p>
|
|||
|
</div>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><ul class="simple">
|
|||
|
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType</span></code></a>) – The entity type for which these checks are being run. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – If the entity type is HOST then the host identifier for which the
|
|||
|
checks have been run. This attribute was added in vSphere API
|
|||
|
8.0.0.1.
|
|||
|
When clients pass a value of this class as a parameter, the
|
|||
|
attribute must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
return value, the attribute will be an identifier for the resource
|
|||
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
|
|||
|
This attribute is optional and it is only relevant when the value
|
|||
|
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
|
|||
|
<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType.HOST</span></code></a>.</p></li>
|
|||
|
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a>) – Aggregated status from all checks performed on this entity. This
|
|||
|
attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
<li><p><strong>check_statuses</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckStatus" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckStatus</span></code></a>) – List of <code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckStatus</span></code> for all checks performed.
|
|||
|
This attribute was added in vSphere API 8.0.0.1.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EntityType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType</span></code> class contains the
|
|||
|
entities on which checks can be performed. This enumeration was added in
|
|||
|
vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition note">
|
|||
|
<p class="admonition-title">Note</p>
|
|||
|
<p>This class represents an enumerated type in the interface language
|
|||
|
definition. The class contains class attributes which represent the
|
|||
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
the enumerated type may contain new values. To use new values of the
|
|||
|
enumerated type in communication with a server that supports the newer
|
|||
|
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">EntityType</span></code> instance.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST">
|
|||
|
<span class="sig-name descname"><span class="pre">HOST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">EntityType(string='HOST')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Entity type Host. This class attribute was added in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
|
|||
|
<p>The <code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code> class defines the status result for a
|
|||
|
particular check. This enumeration was added in vSphere API 8.0.0.1.</p>
|
|||
|
<div class="admonition note">
|
|||
|
<p class="admonition-title">Note</p>
|
|||
|
<p>This class represents an enumerated type in the interface language
|
|||
|
definition. The class contains class attributes which represent the
|
|||
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
the enumerated type may contain new values. To use new values of the
|
|||
|
enumerated type in communication with a server that supports the newer
|
|||
|
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.ERROR">
|
|||
|
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.ERROR" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The check indicates an error. This class attribute was added in vSphere API
|
|||
|
8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.OK">
|
|||
|
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.OK" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The check indicates a success. This class attribute was added in vSphere
|
|||
|
API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.TIMEOUT">
|
|||
|
<span class="sig-name descname"><span class="pre">TIMEOUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='TIMEOUT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.TIMEOUT" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The check did not return in a timely manner. This class attribute was added
|
|||
|
in vSphere API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py attribute">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.WARNING">
|
|||
|
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.Status.WARNING" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>The check indicates a warning. This class attribute was added in vSphere
|
|||
|
API 8.0.0.1.</p>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py method">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.get">
|
|||
|
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.get" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Returns the most recent available result of checks run on the
|
|||
|
standalone host before the application of the desired software document
|
|||
|
to the host. This method was added in vSphere API 8.0.0.1.</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The host identifier.
|
|||
|
The parameter must be an identifier for the resource type:
|
|||
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckResult" title="com.vmware.esx.settings.hosts.software.reports_client.LastCheckResult.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">LastCheckResult.CheckResult</span></code></a></p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p>Most recent available result of the checks run on the host.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
If there is an unknown internal error. The accompanying error
|
|||
|
message will give more details about the failure.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise<span class="colon">:</span></dt>
|
|||
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
If there is no standalone host associated with <code class="docutils literal notranslate"><span class="pre">host</span></code> in the
|
|||
|
system or if there is no result associated with the host <code class="docutils literal notranslate"><span class="pre">host</span></code>.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-even">Raise<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></dt>
|
|||
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
If the host is not a vLCM managed standlone host.</p>
|
|||
|
</dd>
|
|||
|
<dt class="field-odd">Raise<span class="colon">:</span></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.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
|||
|
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code> referenced by the parameter <code class="docutils literal notranslate"><span class="pre">host</span></code>
|
|||
|
requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareRemediation.Read</span></code>.</p></li>
|
|||
|
</ul>
|
|||
|
</dd>
|
|||
|
</dl>
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
</dd></dl>
|
|||
|
|
|||
|
<dl class="py class">
|
|||
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.hosts.software.reports_client.StubFactory">
|
|||
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.hosts.software.reports_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.hosts.software.reports_client.StubFactory" title="Permalink to this definition"></a></dt>
|
|||
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
|
|||
|
<p>Initialize StubFactoryBase</p>
|
|||
|
<dl class="field-list simple">
|
|||
|
<dt class="field-odd">Parameters<span class="colon">:</span></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>
|
|||
|
|
|||
|
</section>
|
|||
|
</section>
|
|||
|
|
|||
|
|
|||
|
</div>
|
|||
|
</div>
|
|||
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
<a href="com.vmware.esx.settings.hosts.policies.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.hosts.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
<a href="com.vmware.esx.settings.hosts.software.drafts.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.hosts.software.drafts package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
</div>
|
|||
|
|
|||
|
<hr/>
|
|||
|
|
|||
|
<div role="contentinfo">
|
|||
|
<p>© Copyright 2024, Broadcom, Inc..</p>
|
|||
|
</div>
|
|||
|
|
|||
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|||
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|||
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|||
|
|
|||
|
</footer>
|
|||
|
</div>
|
|||
|
</div>
|
|||
|
</section>
|
|||
|
</div>
|
|||
|
<script>
|
|||
|
jQuery(function () {
|
|||
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
});
|
|||
|
</script>
|
|||
|
|
|||
|
</body>
|
|||
|
</html>
|