<spanid="com-vmware-esx-package"></span><h1>com.vmware.esx package<aclass="headerlink"href="#module-com.vmware.esx"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-esx-hcl-client-module"></span><h2>com.vmware.esx.hcl_client module<aclass="headerlink"href="#module-com.vmware.esx.hcl_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hcl_client</span></code> module provides classes to query the hardware
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CompatibilityData</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.CompatibilityData"title="Permalink to this definition">¶</a></dt>
<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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Status</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">updated_at</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.CompatibilityData.Status"title="Permalink to this definition">¶</a></dt>
<li><p><strong>updated_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Indicates when the data was last updated.</p></li>
<li><p><strong>notifications</strong> (<aclass="reference internal"href="#com.vmware.esx.hcl_client.Notifications"title="com.vmware.esx.hcl_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a>) – Notifications returned by the operation.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="sig-name descname"><spanclass="pre">update_task</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CompatibilityStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.CompatibilityStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CompatibilityStatus</span></code> class defines compatibility status of a given
server or PCI device against a specific release of ESXi.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.esx.hcl_client.CompatibilityStatus"title="com.vmware.esx.hcl_client.CompatibilityStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CompatibilityStatus</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CERTIFIED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CompatibilityStatus(string='CERTIFIED')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">COMPATIBLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CompatibilityStatus(string='COMPATIBLE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">INCOMPATIBLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CompatibilityStatus(string='INCOMPATIBLE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">NOT_CERTIFIED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CompatibilityStatus(string='NOT_CERTIFIED')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">UNAVAILABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CompatibilityStatus(string='UNAVAILABLE')</span></em><aclass="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>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.Driver">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Driver</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Driver"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Driver</span></code> class contains attributes describing information about a
driver.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the driver.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of the driver.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The vendor that produced the driver.
If None vendor is unknown.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.Firmware">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Firmware</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Firmware"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Firmware</span></code> class contains attributes describing information about a
firmware.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of the firmware.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The vendor that produced the firmware.
If None vendor is unknown.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.Notification">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notification</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resolution</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Notification"title="Permalink to this definition">¶</a></dt>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The time the notification was raised/found.</p></li>
<li><p><strong>resolution</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The resolution message, if any.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if there is a resolution available for this
notification.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.Notifications">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notifications</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">errors</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Notifications"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PCIDevice</span></code> class contains attributes describing information about a
single PCI device on a host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>pci_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The device’s address in a given ESXi host.</p></li>
<li><p><strong>vid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A unique number that identifies the specific device of the Vendor
(VID).</p></li>
<li><p><strong>svid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A unique number that identifies the card manufacturer.</p></li>
<li><p><strong>ssid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A unique number that identifies the specific device of Subsystem
Vendor (SVID).</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the vendor.</p></li>
<li><p><strong>model_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the device model.</p></li>
<li><p><strong>class_code</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Register that specifies the type of function the device performs.</p></li>
<li><p><strong>sub_class_code</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Register that specifies the specific function the device performs.</p></li>
<li><p><strong>driver</strong> (<aclass="reference internal"href="#com.vmware.esx.hcl_client.Driver"title="com.vmware.esx.hcl_client.Driver"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Driver</span></code></a>) – Currently installed driver used by the device.</p></li>
<li><p><strong>firmware</strong> (<aclass="reference internal"href="#com.vmware.esx.hcl_client.Firmware"title="com.vmware.esx.hcl_client.Firmware"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Firmware</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Shows whether the device is part of VSAN cluster or not.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.Reports">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Reports</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Reports"title="Permalink to this definition">¶</a></dt>
<p>This class provides methods to download information generated from the
hardware compatibility feature residing on the vCenter Appliance.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Location</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">url</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">report_token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Reports.Location"title="Permalink to this definition">¶</a></dt>
<li><p><strong>report_token</strong> (<aclass="reference internal"href="#com.vmware.esx.hcl_client.Reports.Token"title="com.vmware.esx.hcl_client.Reports.Token"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.Reports.Token">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Token</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">expiry</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Reports.Token"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Expiry time of the token</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtid="com.vmware.esx.hcl_client.Reports.get">
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">report</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Reports.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the location <aclass="reference internal"href="#com.vmware.esx.hcl_client.Reports.Location"title="com.vmware.esx.hcl_client.Reports.Location"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Reports.Location</span></code></a> information for
downloading a compatibility report.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>report</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – identifier of hardware compatiblity report to be downloaded.
The parameter must be an identifier for the resource type:
<ddclass="field-odd"><p><codeclass="docutils literal notranslate"><spanclass="pre">Reports.Location</span></code> class which includes the URI to file, short
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Server</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">model_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_series</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cpu_features</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">bios</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.Server"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Server</span></code> class contains attributes describing information about a
server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>model_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the server model (for example, “PowerEdge R740xd”).</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the vendor (for example, “Dell”).</p></li>
<li><p><strong>cpu_series</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The CPU series name (for example, “Intel Xeon Gold 6100/5100,
<p><strong>Note</strong>: This attribute is initialized with the CPU <em>model</em> name;
it’s updated to the actual CPU series later, based on recognizing
one of the CPU series the server hardware is certified with in the
VCG.s</p>
</p></li>
<li><p><strong>cpu_features</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The current CPU features.</p></li>
<li><p><strong>bios</strong> (<aclass="reference internal"href="#com.vmware.esx.hcl_client.Firmware"title="com.vmware.esx.hcl_client.Firmware"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Firmware</span></code></a>) – Currently installed BIOS of the server.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hcl_client.StubFactory">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hcl_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hcl_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-hosts-client-module"></span><h2>com.vmware.esx.hosts_client module<aclass="headerlink"href="#module-com.vmware.esx.hosts_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOnInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.AddOnInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOnInfo</span></code> class contains attributes that describe a specific OEM
customization add-on in the software solution.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hosts.add_on</span></code>.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the add-on</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the OEM add-on.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the OEM add-on.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hosts_client.AddOnSpec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOnSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.AddOnSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOnSpec</span></code> class contains attributes that describe a specific OEM
customization add-on in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the add-on</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the add-on</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">release_date</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.BaseImageInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImageInfo</span></code> class contains attributes that describe a specific
ESX base-image in the software solution.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hosts.base_image</span></code>.</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the base-image.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the base-image.</p></li>
<li><p><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Release date of the base-image.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.BaseImageSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImageSpec</span></code> class contains attributes that describe a specific
ESX base-image in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the base-image</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CertificateInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumbprint</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.CertificateInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">CertificateInfo</span></code> Class contains information about the SSL
certificate for a server.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>ssl_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The SHA thumbprint of the SSL certificate for a server.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComponentInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code> class contains attributes that describe a specific
component version in the software solution.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the component.</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the component.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the component.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the component.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">packages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.HardwareSupportInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareSupportInfo</span></code> class contains information to describe the
Hardware Support Package (HSP) in the software solution.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.hosts_client.HardwareSupportPackageInfo"title="com.vmware.esx.hosts_client.HardwareSupportPackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportPackageInfo</span></code></a>) – Map of Hardware Support Packages (HSPs). 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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hosts.hardware_support.manager</span></code>. When
methods return a value of this class as a return value, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportPackageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pkg</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.HardwareSupportPackageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the Hardware Support Package (HSP) selected (e.g.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportPackageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pkg</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.HardwareSupportPackageSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">packages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.HardwareSupportSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareSupportSpec</span></code> class contains attributes to describe the
Hardware Support Packages (HSP) included in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.hosts_client.HardwareSupportPackageSpec"title="com.vmware.esx.hosts_client.HardwareSupportPackageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportPackageSpec</span></code></a>) – Map of Hardware Support Packages (HSPs). 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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hosts.hardware_support.manager</span></code>. When
methods return a value of this class as a return value, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notification</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">resolution</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Notification"title="Permalink to this definition">¶</a></dt>
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The time the notification was raised/found.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notifications</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">errors</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Notifications"title="Permalink to this definition">¶</a></dt>
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if an error was reported by the task.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hosts_client.Software">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Software</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software</span></code> class provides methods to get and extract the current
software specification applied to the host.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ConnectionSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">auth_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host_credential</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.ConnectionSpec"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>auth_type</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.ConnectionSpec.AuthenticationType"title="com.vmware.esx.hosts_client.Software.ConnectionSpec.AuthenticationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.ConnectionSpec.AuthenticationType</span></code></a>) – Specifies what type of authentication (USERNAME_PASSWORD, EXISTING)
is to be used when connecting with the host. USERNAME_PASSWORD is
intended to be used when connecting to a host that is not currently
part of the vCenter inventory. EXISTING is intented for hosts that
are in vCenter inventory, in which case, HostServiceTicket will be
used to connect to the host.</p></li>
<li><p><strong>host_credential</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.HostCredentials"title="com.vmware.esx.hosts_client.Software.HostCredentials"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.HostCredentials</span></code></a>) – Specifies the host details to be used during the
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Specifies the host Managed Object ID to be used during the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">AuthenticationType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.ConnectionSpec.AuthenticationType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.ConnectionSpec.AuthenticationType</span></code> class defines the
possible types of authentication supported when connecting to the host.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AuthenticationType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">EXISTING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">AuthenticationType(string='EXISTING')</span></em><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.ConnectionSpec.AuthenticationType.EXISTING"title="Permalink to this definition">¶</a></dt>
<dd><p>Connect to the host using service ticket. Note: This is supported only for
<codeclass="sig-name descname"><spanclass="pre">USERNAME_PASSWORD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">AuthenticationType(string='USERNAME_PASSWORD')</span></em><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD"title="Permalink to this definition">¶</a></dt>
<dd><p>Connect to host using host’s credentials <codeclass="docutils literal notranslate"><spanclass="pre">HostCredentials</span></code> class.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HostCredentials</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">user_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">password</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">port</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ssl_thumb_print</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.HostCredentials"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>host_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The IP address or DNS resolvable name of the host.</p></li>
<li><p><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Specifies the username to be used during the <aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.get"title="com.vmware.esx.hosts_client.Software.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.get()</span></code></a>
method</p></li>
<li><p><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Specifies the password to be used during the <aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.get"title="com.vmware.esx.hosts_client.Software.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.get()</span></code></a>
method</p></li>
<li><p><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies the port number of the host to be used during
<li><p><strong>ssl_thumb_print</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies the sslThumbPrint of the host to be used during
<aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.get"title="com.vmware.esx.hosts_client.Software.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.get()</span></code></a> method SHA1 hash of the host’s SSL
certificate.
If None, <aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.get"title="com.vmware.esx.hosts_client.Software.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.get()</span></code></a> method throws UnverifiedPeer with the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">software_info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.Info</span></code> class contains attributes that describe the current
software information on a host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>notifications</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.Notifications"title="com.vmware.esx.hosts_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a>) – Notifications returned by the get operation.</p></li>
<li><p><strong>software_info</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.SoftwareInfo"title="com.vmware.esx.hosts_client.SoftwareInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SoftwareInfo</span></code></a>) – Host software information returned by the get operation.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtid="com.vmware.esx.hosts_client.Software.get">
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.Software.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns details about the current software specification applied to the
host.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.Software.ConnectionSpec"title="com.vmware.esx.hosts_client.Software.ConnectionSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.ConnectionSpec</span></code></a>) – ConnectionSpec connection spec for the host.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SoftwareInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">base_image</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">add_on</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">solutions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hardware_support</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.SoftwareInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SoftwareInfo</span></code> class contains attributes that describes the software
solution for an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>base_image</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.BaseImageInfo"title="com.vmware.esx.hosts_client.BaseImageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageInfo</span></code></a>) – Base image of the ESX.</p></li>
<li><p><strong>add_on</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.AddOnInfo"title="com.vmware.esx.hosts_client.AddOnInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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 exists.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<aclass="reference internal"href="#com.vmware.esx.hosts_client.ComponentInfo"title="com.vmware.esx.hosts_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><p><strong>solutions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.hosts_client.SolutionInfo"title="com.vmware.esx.hosts_client.SolutionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><p><strong>hardware_support</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.HardwareSupportInfo"title="com.vmware.esx.hosts_client.HardwareSupportInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about the Hardware Support Packages (HSP) configured.
If None, no Hardware Support Package (HSP) info exists.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hosts_client.SoftwareSpec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SoftwareSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">base_image</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">add_on</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">solutions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hardware_support</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.SoftwareSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SoftwareSpec</span></code> class contains attributes that describe software
specification for an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>base_image</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.BaseImageSpec"title="com.vmware.esx.hosts_client.BaseImageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageSpec</span></code></a>) – Base image of the ESX.</p></li>
<li><p><strong>add_on</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.AddOnSpec"title="com.vmware.esx.hosts_client.AddOnSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>)) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Additional components which are 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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SoftwareSpec.add_on</span></code> and
If None, no solutions are present in the software specification.</p></li>
<li><p><strong>hardware_support</strong> (<aclass="reference internal"href="#com.vmware.esx.hosts_client.HardwareSupportSpec"title="com.vmware.esx.hosts_client.HardwareSupportSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about the Hardware Support Package (HSP) configured in
the software specification.
If None or empty, no firmware info will be part of the software
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionComponentSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">component</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.SolutionComponentSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SolutionComponentSpec</span></code> class contains attributes that describe a
component registered by a software solution.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>component</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hosts.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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.hosts.component</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hosts_client.SolutionInfo">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.SolutionInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SolutionInfo</span></code> class contains attributes that describe solution
registered in the software solution.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the solution.</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the solution.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.hosts_client.ComponentInfo"title="com.vmware.esx.hosts_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.SolutionSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SolutionSpec</span></code> class contains attributes that describe solution
registered in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the solution.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.hosts_client.SolutionComponentSpec"title="com.vmware.esx.hosts_client.SolutionComponentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SolutionComponentSpec</span></code></a>) – Components registered by the solution.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.hosts_client.StubFactory">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.hosts_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.hosts_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-client-module"></span><h2>com.vmware.esx.settings_client module<aclass="headerlink"href="#module-com.vmware.esx.settings_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client</span></code> module provides classes to manage ESX
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOnCompliance</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">current</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.AddOnCompliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Compliance status of the OEM add-on.</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.AddOnInfo"title="com.vmware.esx.settings_client.AddOnInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.AddOnInfo"title="com.vmware.esx.settings_client.AddOnInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOnDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.AddOnDetails"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOnDetails</span></code> class contains information that provide more details
about the add-on from the depot.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the OEM add-on.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the OEM add-on.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the OEM add-on.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.settings_client.AddOnInfo">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOnInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.AddOnInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOnInfo</span></code> class contains information that describe a specific OEM
customization add-on.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>details</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.AddOnDetails"title="com.vmware.esx.settings_client.AddOnDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the add-on</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the add-on</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dlclass="py class">
<dtid="com.vmware.esx.settings_client.AddOnSpec">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOnSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.AddOnSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOnSpec</span></code> class contains attributes that describe a specific OEM
customization add-on.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the add-on</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the add-on</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImageCompliance</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">current</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.BaseImageCompliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Compliance status of the base image.</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.BaseImageInfo"title="com.vmware.esx.settings_client.BaseImageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageInfo</span></code></a>) – Current base image information on the host.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.BaseImageInfo"title="com.vmware.esx.settings_client.BaseImageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageInfo</span></code></a>) – Target base image information present in the software
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImageDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">release_date</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.BaseImageDetails"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImageDetails</span></code> class contains information that provide more
details about the base image from the depot.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the base-image.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the base-image.</p></li>
<li><p><strong>release_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Release date of the base-image.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.BaseImageInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImageInfo</span></code> class contains information that describe a specific
ESX base-image.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>details</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.BaseImageDetails"title="com.vmware.esx.settings_client.BaseImageDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the base-image</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.BaseImageSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImageSpec</span></code> class contains attributes that describe a specific
ESX base-image.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the base-image</p>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Overall compliance state of the host.</p></li>
<li><p><strong>notifications</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.Notifications"title="com.vmware.esx.settings_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a>) – Notifications returned by the scan operation.</p></li>
<li><p><strong>commit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings.commit</span></code>.
None if operation is performed on a draft.</p></li>
<li><p><strong>compliant_hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
<li><p><strong>unavailable_hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifiers of unavailable hosts. There will not be compliance
details for these hosts in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
<li><p><strong>hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.HostCompliance"title="com.vmware.esx.settings_client.HostCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as
a return value, the key in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an
identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>.</p></li>
<li><p><strong>host_info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.HostInfo"title="com.vmware.esx.settings_client.HostInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as
a return value, the key in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an
identifier for the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComplianceImpact</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.ComplianceImpact"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComplianceImpact</span></code> class contains information about the impact of
applying the target state in case of non compliance.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceImpact"title="com.vmware.esx.settings_client.ComplianceImpact"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceImpact</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">MAINTENANCE_MODE_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceImpact(string='MAINTENANCE_MODE_REQUIRED')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">NO_IMPACT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceImpact(string='NO_IMPACT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.ComplianceImpact.NO_IMPACT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">REBOOT_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceImpact(string='REBOOT_REQUIRED')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">UNKNOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceImpact(string='UNKNOWN')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.ComplianceImpact.UNKNOWN"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComplianceStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.ComplianceStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code> class contains the possible different status of
compliance with respect to target version.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">COMPLIANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceStatus(string='COMPLIANT')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">INCOMPATIBLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceStatus(string='INCOMPATIBLE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">NON_COMPLIANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceStatus(string='NON_COMPLIANT')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">UNAVAILABLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceStatus(string='UNAVAILABLE')</span></em><aclass="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
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Compliance status of the component.</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentInfo"title="com.vmware.esx.settings_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentInfo"title="com.vmware.esx.settings_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentSource"title="com.vmware.esx.settings_client.ComponentSource"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentSource</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentSource"title="com.vmware.esx.settings_client.ComponentSource"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentSource</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Source of the component in the software specification.
None if component is not present in the software specification.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComponentDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.ComponentDetails"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComponentDetails</span></code> class contains information that provide more
details about the component from the depot.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the component.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the component.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Human readable version of the component.
None if no version is provided for the component.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComponentInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code> class contains information that describe a specific
component version in a software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version of the component.
None if version is not specified.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentDetails"title="com.vmware.esx.settings_client.ComponentDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the component.
None if component is not present in the depot.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComponentOverrideInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">source</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">note</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.ComponentOverrideInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComponentOverrideInfo</span></code> class contains fields that describe how the
component was overridden.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the component override.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the component override.</p></li>
<li><p><strong>source</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentSource"title="com.vmware.esx.settings_client.ComponentSource"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentSource</span></code></a>) – Source of the component override.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComponentSource</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.ComponentSource"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComponentSource</span></code> class contains the component’s source information.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentSource"title="com.vmware.esx.settings_client.ComponentSource"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentSource</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ADD_ON</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentSource(string='ADD_ON')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.ComponentSource.ADD_ON"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">BASE_IMAGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentSource(string='BASE_IMAGE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">HARDWARE_SUPPORT_PACKAGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentSource(string='HARDWARE_SUPPORT_PACKAGE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">SOLUTION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentSource(string='SOLUTION')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">USER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentSource(string='USER')</span></em><aclass="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>
<dlclass="py class">
<dtid="com.vmware.esx.settings_client.Depots">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Depots</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.Depots"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Depots</span></code> class provides methods to manage Software Depots used during
ESX lifecycle management.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname"><spanclass="pre">sync_task</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">EffectiveComponentDetails</span></code> class contains information that provide
more details about the component from the depot.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the component.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Human readable version of the component.</p></li>
<li><p><strong>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the component.</p></li>
<li><p><strong>source</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentSource"title="com.vmware.esx.settings_client.ComponentSource"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentSource</span></code></a>) – Final effective source of the component.</p></li>
<li><p><strong>note</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentOverrideInfo"title="com.vmware.esx.settings_client.ComponentOverrideInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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,
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">EffectiveComponentDetails.source</span></code> would be USER and there
will be one entry in this list indicating base-image component
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">EffectiveComponentInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.EffectiveComponentInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">EffectiveComponentInfo</span></code> class contains information that describe a
component and how that component appeared in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the component.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.EffectiveComponentDetails"title="com.vmware.esx.settings_client.EffectiveComponentDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EffectiveComponentDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the effective component.
None if component is not present in the depot.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareModuleClass</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleClass"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareModuleClass</span></code> class contains the module’s source information.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareModuleClass"title="com.vmware.esx.settings_client.HardwareModuleClass"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareModuleClass</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">OTHER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HardwareModuleClass(string='OTHER')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleClass.OTHER"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">PCI_DEVICE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HardwareModuleClass(string='PCI_DEVICE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleClass.PCI_DEVICE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SYSTEM_BIOS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HardwareModuleClass(string='SYSTEM_BIOS')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleClass.SYSTEM_BIOS"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareModuleDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">component_class</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleDetails"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareModuleFirmwareCompliance</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">current</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Compliance status of the hardware module’s firmware.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareModuleDetails"title="com.vmware.esx.settings_client.HardwareModuleDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareModuleDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"title="com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareModuleFirmwareInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"title="com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareModuleFirmwareInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareModuleFirmwareInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareModuleFirmwareInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareModuleFirmwareInfo</span></code> class contains information to describe
the firmware on a hardware component or module (e.g. BIOS, PCI device).</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the hardware module firmware.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">packages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareSupportInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareSupportInfo</span></code> class contains information to describe the
desired Hardware Support Package (HSP) configured for a cluster.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportPackageInfo"title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportPackageCompliance</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">current</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hardware_modules</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareSupportPackageCompliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Compliance status of the Hardware Support Package (HSP).</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportPackageInfo"title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportPackageInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportPackageInfo"title="com.vmware.esx.settings_client.HardwareSupportPackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportPackageInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance"title="com.vmware.esx.settings_client.HardwareModuleFirmwareCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportPackageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pkg</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareSupportPackageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the Hardware Support Package (HSP) selected (e.g.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportPackageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">pkg</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareSupportPackageSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupportSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">packages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HardwareSupportSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareSupportSpec</span></code> class contains attributes to describe the
desired Hardware Support Package (HSP) configured for a cluster.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportPackageSpec"title="com.vmware.esx.settings_client.HardwareSupportPackageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Overall compliance state of the host.</p></li>
<li><p><strong>notifications</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.Notifications"title="com.vmware.esx.settings_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a>) – Notifications returned by the scan operation.</p></li>
<li><p><strong>commit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.BaseImageCompliance"title="com.vmware.esx.settings_client.BaseImageCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageCompliance</span></code></a>) – Compliance result for the base image.</p></li>
<li><p><strong>add_on</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.AddOnCompliance"title="com.vmware.esx.settings_client.AddOnCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnCompliance</span></code></a>) – Compliance result for the OEM add-on.</p></li>
<li><p><strong>hardware_support</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportPackageCompliance"title="com.vmware.esx.settings_client.HardwareSupportPackageCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportPackageCompliance</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource
This attribute will be None or contain an empty map if operation is
performed on an image whose <codeclass="docutils literal notranslate"><spanclass="pre">SoftwareSpec</span></code> does not have a value
for its <codeclass="docutils literal notranslate"><spanclass="pre">hardwareSupport</span></code> attribute.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentCompliance"title="com.vmware.esx.settings_client.ComponentCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><p><strong>solutions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionCompliance"title="com.vmware.esx.settings_client.SolutionCompliance"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.HostInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HostInfo</span></code> class contains attributes to describe some details
regarding a host in the inventory.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the host.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Notification</span></code> class contains attributes to describe any
info/warning/error messages that Tasks can raise.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.Notification.Type"title="com.vmware.esx.settings_client.Notification.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notification.Type</span></code></a>) – Type of the notification. This attribute was added in vSphere API
7.0.2.0.
This attribute is optional because it was added in a newer version
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The time the notification was raised/found.</p></li>
<li><p><strong>resolution</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The resolution message, if any.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if there is a resolution available for this
notification.</p></li>
<li><p><strong>originator</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>retriable</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings_client.Notification.Type.ERROR"title="com.vmware.esx.settings_client.Notification.Type.ERROR"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Notification.Type.ERROR</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Type</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.Notification.Type"title="Permalink to this definition">¶</a></dt>
<p>The (\@name Type} class contains the possible different types of
notification. This enumeration was added in vSphere API 7.0.2.0.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.Notification.Type.ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">INFO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='INFO')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.Notification.Type.INFO"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.esx.settings_client.Notification.Type.WARNING"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Notifications</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">errors</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.Notifications"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SoftwareInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">base_image</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">add_on</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">solutions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hardware_support</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SoftwareInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SoftwareInfo</span></code> class contains information that describes the desired
software specification for an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>base_image</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.BaseImageInfo"title="com.vmware.esx.settings_client.BaseImageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageInfo</span></code></a>) – Base image of the ESX.</p></li>
<li><p><strong>add_on</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.AddOnInfo"title="com.vmware.esx.settings_client.AddOnInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.ComponentInfo"title="com.vmware.esx.settings_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><p><strong>solutions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionInfo"title="com.vmware.esx.settings_client.SolutionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><p><strong>hardware_support</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportInfo"title="com.vmware.esx.settings_client.HardwareSupportInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about the Hardware Support Packages (HSP) configured.
If None, no Hardware Support Package (HSP) is specified for the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SoftwareSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">base_image</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">add_on</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">solutions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hardware_support</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SoftwareSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SoftwareSpec</span></code> class contains attributes that describe desired
software specification for an ESX host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>base_image</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.BaseImageSpec"title="com.vmware.esx.settings_client.BaseImageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImageSpec</span></code></a>) – Base image of the ESX.</p></li>
<li><p><strong>add_on</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.AddOnSpec"title="com.vmware.esx.settings_client.AddOnSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOnSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>)) or <codeclass="docutils literal notranslate"><spanclass="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
If None, no solutions will be part of the software specification.</p></li>
<li><p><strong>hardware_support</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.HardwareSupportSpec"title="com.vmware.esx.settings_client.HardwareSupportSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HardwareSupportSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionCompliance</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">current</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">target</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">notifications</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SolutionCompliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.ComplianceStatus"title="com.vmware.esx.settings_client.ComplianceStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceStatus</span></code></a>) – Compliance status of the solution.</p></li>
<li><p><strong>current</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionInfo"title="com.vmware.esx.settings_client.SolutionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SolutionInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionInfo"title="com.vmware.esx.settings_client.SolutionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SolutionInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Target solution present in the software specification.
None if solution is not present in the software specification.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionComponentDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">component</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vendor</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SolutionComponentDetails"title="Permalink to this definition">¶</a></dt>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the component.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the component.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionComponentSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">component</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SolutionComponentSpec"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SolutionDetails"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SolutionDetails</span></code> class contains information that provide more
details about the solution from the depot.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of the solution.</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display version of the solution.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionComponentDetails"title="com.vmware.esx.settings_client.SolutionComponentDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SolutionInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SolutionInfo</span></code> class contains information that describe solution
registered in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>details</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionDetails"title="com.vmware.esx.settings_client.SolutionDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SolutionDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the solution.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionComponentSpec"title="com.vmware.esx.settings_client.SolutionComponentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SolutionComponentSpec</span></code></a>) – Components registered by the solution.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SolutionSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">components</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.SolutionSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SolutionSpec</span></code> class contains attributes that describe solution
registered in the software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the solution.</p></li>
<li><p><strong>components</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings_client.SolutionComponentSpec"title="com.vmware.esx.settings_client.SolutionComponentSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SolutionComponentSpec</span></code></a>) – Components registered by the solution.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<li><p><strong>subtasks</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.esx.settings_client.TaskInfo"title="com.vmware.esx.settings_client.TaskInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TaskInfo</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.cis.task</span></code>. When methods return a value of this
class as a return value, the key in the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>
This attribute will be None if the task has no subtasks.</p></li>
<li><p><strong>notifications</strong> (<aclass="reference internal"href="#com.vmware.esx.settings_client.Notifications"title="com.vmware.esx.settings_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Notifications</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Notifications to the user
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if the notifications were reported by this
This attribute will be None if the task has no result.</p></li>
<li><p><strong>last_update_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</p></li>
<li><p><strong>operation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><strong>parent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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
This attribute will be None if the task has no parent.</p></li>
<li><p><strong>target</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.DynamicID"title="com.vmware.vapi.std_client.DynamicID"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.DynamicID</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status"title="com.vmware.cis.task_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Exception</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is started.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation is completed.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is one of
<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Status.SUCCEEDED"title="com.vmware.cis.task_client.Status.SUCCEEDED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Status.SUCCEEDED</span></code></a> or
<li><p><strong>user</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the user who performed the operation.
This attribute will be None if the operation is performed by the
