<spanid="com-vmware-esx-settings-package"></span><h1>com.vmware.esx.settings package<aclass="headerlink"href="#module-com.vmware.esx.settings"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-settings-clusters-client-module"></span><h2>com.vmware.esx.settings.clusters_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.clusters_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings.clusters_client</span></code> module provides classes to
manage desired state configuration and software for a cluster of ESX hosts.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DepotOverrides</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.clusters_client.DepotOverrides"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DepotOverrides</span></code> class provides methods to manage software depots
overriden for a given cluster. In general ESX servers reach out to vCenter
(VUM) to fetch the metadata and payloads required for lifecycle operations.
But in ROBO environments ESX clusters can’t (or because of bandwidth
requirements shouldn’t) reach out to vCenter to fetch payloads and
metadata. This class allows setting cluster level overrides for depots. If
any depots are provided for a cluster, then vCenter level depots are not
used for that cluster’s remediation. These are not synced periodically at
vCenter and are only used by ESXs for lifecycle operations.</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">Depot</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">location</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.clusters_client.DepotOverrides.Depot"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot override. This could be a location of zip
<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">depots</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.clusters_client.DepotOverrides.Info"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">add</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.DepotOverrides.add"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a new depot override to the list of currently configured depot
overrides for a given cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster.
The parameter must be an identifier for the resource type:
<li><p><strong>depot</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"title="com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DepotOverrides.Depot</span></code></a>) – Information of a depot override.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.DepotOverrides.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the information about currently configured depot overrides for
a given cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">remove</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.DepotOverrides.remove"title="Permalink to this definition">¶</a></dt>
<dd><p>Removes a depot override from the list of currently configured depot
overrides for a given cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster.
The parameter must be an identifier for the resource type:
<li><p><strong>depot</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"title="com.vmware.esx.settings.clusters_client.DepotOverrides.Depot"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DepotOverrides.Depot</span></code></a>) – Information of the depot override to be removed.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters_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.settings.clusters_client.Software"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software</span></code> class provides methods to manage desired software
specification of an ESX cluster.</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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.ApplyResult</span></code> class contains attributes that describe the
result of an <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method.</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.clusters_client.Software.ApplyStatus"title="com.vmware.esx.settings.clusters_client.Software.ApplyStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.ApplyStatus</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies the aggregated status of the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code>
method.
None if the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method is in progress.</p></li>
<li><p><strong>commit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the commit used to fetch the desired software
document to be applied to all hosts within the cluster.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<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>.</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.html#com.vmware.esx.settings_client.HostInfo"title="com.vmware.esx.settings_client.HostInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information of the hosts in this cluster to which the desired
software document specified by the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.ApplyResult.commit</span></code> should be applied to.
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_status</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.clusters_client.Software.ApplyStatus"title="com.vmware.esx.settings.clusters_client.Software.ApplyStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.ApplyStatus</span></code></a>) – Status of the hosts in this cluster to which the desired software
document specified by the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.ApplyResult.commit</span></code> was
applied to. Hosts on which the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method was
successful are specified by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.ApplyResult.successful_hosts</span></code>. Hosts on which the
apply method failed are specified by
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.ApplyResult.failed_hosts</span></code>. Hosts which were skipped
by the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method are specified by
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>successful_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>) – Hosts in this cluster to which the desired software document
specified by the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.ApplyResult.commit</span></code> has been
successfully applied to.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<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>failed_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>) – Hosts in this cluster to which the desired software document
specified by the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.ApplyResult.commit</span></code> failed to be
applied to.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<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>skipped_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>) – Hosts in this cluster that were skipped by the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ApplySpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">commit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hosts</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">accept_eula</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.clusters_client.Software.ApplySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.ApplySpec</span></code> class contains attributes that describe the
specification to be used for applying the desired software document to 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"><ulclass="simple">
<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>) – The minimum commit identifier of the desired software document to
be used during the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method.
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>.
if None or empty the apply method will use the latest commit to
fetch the desired state document.</p></li>
<li><p><strong>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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The specific hosts within the cluster to be considered during the
if None or empty the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method will remediate
all hosts within the cluster.</p></li>
<li><p><strong>accept_eula</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Accept the VMware End User License Agreement (EULA) before starting
the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method. The VMware EULA is available for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ApplyStatus</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">progress</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start_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">end_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">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.clusters_client.Software.ApplyStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.ApplyStatus</span></code> class contains attributes that describe the
status of an <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method.</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.clusters_client.Software.ApplyStatus.Status"title="com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.ApplyStatus.Status</span></code></a>) – The status of the method.</p></li>
<li><p><strong>progress</strong> (<aclass="reference internal"href="com.vmware.cis.html#com.vmware.cis.task_client.Progress"title="com.vmware.cis.task_client.Progress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.cis.task_client.Progress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Progress of the operation. This attribute was added in vSphere API
7.0.1.0.
None for cluster ApplyStatus</p></li>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the method started.</p></li>
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the method completed.</p></li>
<li><p><strong>notifications</strong> (<aclass="reference internal"href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications"title="com.vmware.esx.settings_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications providing additional information about the status of
<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">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.ApplyStatus.Status</span></code> class contains the possible different
status codes that can be returned while trying to <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code>
the desired software specification to hosts within the cluster.</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">Status</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>The method encountered an unspecified error.</p>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='OK')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.OK"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.RUNNING"title="Permalink to this definition">¶</a></dt>
<dd><p>The method is in progress. This class attribute was added in vSphere API
<codeclass="sig-name descname"><spanclass="pre">SKIPPED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='SKIPPED')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.SKIPPED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TIMED_OUT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='TIMED_OUT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ApplyStatus.Status.TIMED_OUT"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">check</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">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">originator</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.clusters_client.Software.CheckInfo"title="Permalink to this definition">¶</a></dt>
<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>) – The service that performed the check. This attribute was added in
vSphere API 7.0.2.0.
Only <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> if there is an originator available for this
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckIssue</span></code><spanclass="sig-paren">(</span><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>, <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.settings.clusters_client.Software.CheckIssue"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>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 what was the issue containing as much user-relevant
context as possible. The user should be able to understand which
sub-system failed and why. This attribute was added in vSphere API
7.0.2.0.</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>) – Possible resolution for the issue. This should contain actionable
information that the user can use to resolve the issue. This
attribute was added in vSphere API 7.0.2.0.
Can be left None if no meaningful resolution exists.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckResult</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">start_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">end_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">commit</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_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">entity_results</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.clusters_client.Software.CheckResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.CheckResult</span></code> class contains attributes that describe
aggregated status of all checks performed.</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.clusters_client.Software.Status"title="com.vmware.esx.settings.clusters_client.Software.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.Status</span></code></a>) – Aggregated status from all checks performed.</p></li>
<li><p><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation started.</p></li>
<li><p><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the operation completed.</p></li>
<li><p><strong>commit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the commit on which checks have been run.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<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>.</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.html#com.vmware.esx.settings_client.HostInfo"title="com.vmware.esx.settings_client.HostInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Information about the hosts in this cluster for which checks have
been requested to be run.
When clients pass a value of this class as a parameter, the key in
the attribute <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>entity_results</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult"title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.EntityCheckResult</span></code></a>) – List of <codeclass="docutils literal notranslate"><spanclass="pre">Software.EntityCheckResult</span></code> for all entities for which
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">commit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hosts</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.clusters_client.Software.CheckSpec"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>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>) – The minimum commit identifier of the desired software document to
be used during the check method.
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>.
if None or empty the check opertion will use the latest commit to
fetch the desired state document.</p></li>
<li><p><strong>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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The specific hosts for which checks need to be performed
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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">check</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <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">issues</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">check_issues</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.clusters_client.Software.CheckStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.CheckStatus</span></code> class contains attributes that describe a
check result.</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>check</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.Software.CheckInfo"title="com.vmware.esx.settings.clusters_client.Software.CheckInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.CheckInfo</span></code></a>) – Information about this check.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.Software.Status"title="com.vmware.esx.settings.clusters_client.Software.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.Status</span></code></a>) – The status of this check.</p></li>
<li><p><strong>issues</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <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>) – The issues encountered while running this check.</p></li>
<li><p><strong>check_issues</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.Software.CheckIssue"title="com.vmware.esx.settings.clusters_client.Software.CheckIssue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.CheckIssue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.CheckIssue`s</span><spanclass="pre">that</span><spanclass="pre">the</span><spanclass="pre">check</span><spanclass="pre">reported.</span><spanclass="pre">This</span>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">EntityCheckResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">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">cluster</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>, <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">check_statuses</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.clusters_client.Software.EntityCheckResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.EntityCheckResult</span></code> class contains attributes that describe
aggregated status of all checks performed on a specific entity.</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.clusters_client.Software.EntityCheckResult.EntityType"title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.EntityCheckResult.EntityType</span></code></a>) – The entity type for which these checks are being run.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – If the entity type is CLUSTER then the cluster identifier for which
the checks have been run.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</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
<li><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – If the entity type is HOST then the host identifier for which the
checks have been run.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
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.clusters_client.Software.EntityCheckResult.EntityType.HOST"title="com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.HOST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Software.EntityCheckResult.EntityType.HOST</span></code></a>.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.Software.Status"title="com.vmware.esx.settings.clusters_client.Software.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.Status</span></code></a>) – Aggregated status from all checks performed on this entity.</p></li>
<li><p><strong>check_statuses</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters_client.Software.CheckStatus"title="com.vmware.esx.settings.clusters_client.Software.CheckStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.CheckStatus</span></code></a>) – List of <codeclass="docutils literal notranslate"><spanclass="pre">Software.CheckStatus</span></code> for all checks performed.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">EntityType</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.clusters_client.Software.EntityCheckResult.EntityType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.EntityCheckResult.EntityType</span></code> class contains the entitites
on which checks can be performed.</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">EntityType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLUSTER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EntityType(string='CLUSTER')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.CLUSTER"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HOST</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">EntityType(string='HOST')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.EntityCheckResult.EntityType.HOST"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ExportSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">export_software_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">export_iso_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">export_offline_bundle</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.clusters_client.Software.ExportSpec"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ExportType</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.clusters_client.Software.ExportType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.ExportType</span></code> class defines the formats in which software
specification document or image can be exported.</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">ExportType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ISO_IMAGE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ExportType(string='ISO_IMAGE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ExportType.ISO_IMAGE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OFFLINE_BUNDLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ExportType(string='OFFLINE_BUNDLE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ExportType.OFFLINE_BUNDLE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SOFTWARE_SPEC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ExportType(string='SOFTWARE_SPEC')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.ExportType.SOFTWARE_SPEC"title="Permalink to this definition">¶</a></dt>
<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">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.Status</span></code> class defines the status result for a particular
check.</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">Status</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.Status.ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">OK</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='OK')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.Status.OK"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RETRY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RETRY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.Status.RETRY"title="Permalink to this definition">¶</a></dt>
<dd><p>The check failed because of an intermittent error, for example a service is
overloaded. The client can choose to retry the health check before
considering the check as failed. This class attribute was added in vSphere
<codeclass="sig-name descname"><spanclass="pre">TIMEOUT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='TIMEOUT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.Status.TIMEOUT"title="Permalink to this definition">¶</a></dt>
<dd><p>The check did not return in a timely manner.</p>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.Status.WARNING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">apply_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.apply_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Applies the desired software document associated with the given cluster
to hosts within the cluster. If <codeclass="docutils literal notranslate"><spanclass="pre">commit</span></code> attribute is <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>,
it implies the minimum commit that the <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Software.apply()</span></code> method
should use, however if subsequent commits have been made to the desired
state document the apply method will use the most recent desired state
document. The result of this operation can be queried by calling the
cis/tasks/{task-id} where the task-id is the response of this
operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
If the <codeclass="docutils literal notranslate"><spanclass="pre">commit</span></code> attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> specifies an invalid
commit, or the <codeclass="docutils literal notranslate"><spanclass="pre">hosts</span></code> attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> specifies an invalid
host or a host not part of the cluster, or the <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> is not
<codeclass="sig-name descname"><spanclass="pre">check_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.check_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Runs checks on the cluster before applying the desired software
document across all hosts in the cluster. Checks if all hosts in the
cluster are in a good state to be updated with the desired software
document. If <codeclass="docutils literal notranslate"><spanclass="pre">commit</span></code> attribute is <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> it implies the
minimum commit that the check method should use, however if subsequent
commits have been made to the desired state document the check method
will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the
task-id is the response of this operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
If the <codeclass="docutils literal notranslate"><spanclass="pre">commit</span></code> attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> specifies an invalid
commit, or the <codeclass="docutils literal notranslate"><spanclass="pre">hosts</span></code> attribute of <codeclass="docutils literal notranslate"><spanclass="pre">spec</span></code> specifies an invalid
<codeclass="sig-name descname"><spanclass="pre">export</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.export"title="Permalink to this definition">¶</a></dt>
<dd><p>Exports the desired software specification document and/or image. This
API will not export the solution section of the desired software
specification.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the complete desired software specification.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">scan_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters_client.Software.scan_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Scans all the hosts in the cluster against the cluster’s desired state.
The result of this operation can be queried by calling the
cis/tasks/{task-id} where the task-id is the response of this
operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters_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.clusters_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-defaults-client-module"></span><h2>com.vmware.esx.settings.defaults_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.defaults_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings.defaults_client</span></code> module provides classes to
manage defaults that affect management of desired state configuration and
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.defaults_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.defaults_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-depot-content-client-module"></span><h2>com.vmware.esx.settings.depot_content_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.depot_content_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings.depot_content_client</span></code> module provides classes to
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depot_content_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOns</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.depot_content_client.AddOns"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOns</span></code> class provides methods to get OEM add-ons from the sync’ed
and imported depots.</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">AddOnVersionSummary</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">summary</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">category</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">kb</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.depot_content_client.AddOns.AddOnVersionSummary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOns.AddOnVersionSummary</span></code> class defines the summary information
regarding a version of an OEM 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>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version 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>
<li><p><strong>summary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Summary of the OEM add-on version.</p></li>
<li><p><strong>category</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType"title="com.vmware.esx.settings.depot_content_client.AddOns.CategoryType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOns.CategoryType</span></code></a>) – Category of the OEM add-on version.</p></li>
<li><p><strong>kb</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Link to kb article related to this the OEM add-on version.</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 OEM add-on version.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CategoryType</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.depot_content_client.AddOns.CategoryType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOns.CategoryType</span></code> class defines possible values of categories for
a OEM add-on.</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">CategoryType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BUGFIX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='BUGFIX')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.BUGFIX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ENHANCEMENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='ENHANCEMENT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.ENHANCEMENT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SECURITY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='SECURITY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.AddOns.CategoryType.SECURITY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vendors</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">names</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">versions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">min_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.depot_content_client.AddOns.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOns.FilterSpec</span></code> class contains attributes used to filter the
results when listing OEM add-ons, see <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.AddOns.list"title="com.vmware.esx.settings.depot_content_client.AddOns.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">AddOns.list()</span></code></a>).</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>vendors</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Vendors that an add-on must have to match the filter.
If None or empty, add-ons from any vendor will match the filter.</p></li>
<li><p><strong>names</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that an add-on must have to match the filter.
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">com.vmware.esx.settings.add_on</span></code>. When methods return a value of
this class as a return value, the attribute will contain
If None or empty, add-ons with any name will match the filter.</p></li>
<li><p><strong>versions</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Versions that an add-on must have to match the filter.
If None or empty, add-ons with any version will match the filter.</p></li>
<li><p><strong>min_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>) – Minimum version of an add-on that can match the filter.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, only OEM add-ons with version greater than or
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.add_on'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.AddOns.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</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">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">versions</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.depot_content_client.AddOns.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOns.Summary</span></code> class defines the summary information regarding a
OEM 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 OEM 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.settings.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.settings.add_on</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 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>versions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.AddOns.AddOnVersionSummary"title="com.vmware.esx.settings.depot_content_client.AddOns.AddOnVersionSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOns.AddOnVersionSummary</span></code></a>) – Summary information about the versions of this addon. These are
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.depot_content_client.AddOns.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of currently available OEM add-ons in the depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec"title="com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOns.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The specification of matching OEM add-ons.
If None, the behavior is equivalent to a <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec"title="com.vmware.esx.settings.depot_content_client.AddOns.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddOns.FilterSpec</span></code></a>
with all attributes None, which means all OEM add-ons match the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depot_content_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImages</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.depot_content_client.BaseImages"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImages</span></code> class provides methods to get base-images from the
sync’ed and imported depots.</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">CategoryType</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.depot_content_client.BaseImages.CategoryType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImages.CategoryType</span></code> class defines possible values of categories
for a base-image.</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">CategoryType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BUGFIX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='BUGFIX')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.BUGFIX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ENHANCEMENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='ENHANCEMENT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.ENHANCEMENT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SECURITY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='SECURITY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType.SECURITY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">min_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.depot_content_client.BaseImages.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImages.FilterSpec</span></code> class contains attributes used to filter the
results when listing base-images, see <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.BaseImages.list"title="com.vmware.esx.settings.depot_content_client.BaseImages.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">BaseImages.list()</span></code></a>).</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>min_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>) – Minimum version of a base-image that can match the filter.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, only base-images with version greater than or
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.base_image'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.BaseImages.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImages.Summary</span></code> class defines the summary information regarding
a 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>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>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.settings.base_image</span></code>. When methods return a value
of this class as a return value, the attribute will be an
<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>summary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Summary of the base-image.</p></li>
<li><p><strong>category</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType"title="com.vmware.esx.settings.depot_content_client.BaseImages.CategoryType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImages.CategoryType</span></code></a>) – Category of the base-image.</p></li>
<li><p><strong>kb</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Link to kb article related to this 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>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.depot_content_client.BaseImages.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of currently available base-images in the depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec"title="com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImages.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The specification of matching base-images.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec"title="com.vmware.esx.settings.depot_content_client.BaseImages.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BaseImages.FilterSpec</span></code></a> with all attributes None, which
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depot_content_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Components</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.depot_content_client.Components"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Components</span></code> class provides methods to get Components from the
sync’ed and imported depots.</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">CategoryType</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.depot_content_client.Components.CategoryType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Components.CategoryType</span></code> class defines possible values of categories
for a component.</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">CategoryType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BUGFIX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='BUGFIX')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.BUGFIX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ENHANCEMENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='ENHANCEMENT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.ENHANCEMENT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">GENERAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='GENERAL')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.GENERAL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">INFO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='INFO')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.INFO"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MISC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='MISC')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.MISC"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RECALL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='RECALL')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.RECALL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RECALL_FIX</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='RECALL_FIX')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.RECALL_FIX"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SECURITY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CategoryType(string='SECURITY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType.SECURITY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ComponentBundleType</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.depot_content_client.Components.ComponentBundleType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Components.ComponentBundleType</span></code> class defines possible ways
components are bundled.</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">ComponentBundleType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ADD_ON</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentBundleType(string='ADD_ON')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.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">ComponentBundleType(string='BASE_IMAGE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.BASE_IMAGE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">INDEPENDENT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComponentBundleType(string='INDEPENDENT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType.INDEPENDENT"title="Permalink to this definition">¶</a></dt>
<dd><p>Components not bundled in base-images or add-ons</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Components.ComponentVersionSummary</span></code> class defines the summary
information regarding a version of a component.</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_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>summary</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Summary of the component version.</p></li>
<li><p><strong>category</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.CategoryType"title="com.vmware.esx.settings.depot_content_client.Components.CategoryType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Components.CategoryType</span></code></a>) – Category of the component version.</p></li>
<li><p><strong>urgency</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType"title="com.vmware.esx.settings.depot_content_client.Components.UrgencyType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Components.UrgencyType</span></code></a>) – Urgency of the component version.</p></li>
<li><p><strong>kb</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Link to kb article related to this the component version.</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 component version.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FilterSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vendors</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">names</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">versions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">min_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">bundle_types</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.depot_content_client.Components.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Components.FilterSpec</span></code> class contains attributes used to filter the
results when listing components, see <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.list"title="com.vmware.esx.settings.depot_content_client.Components.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Components.list()</span></code></a>).</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>vendors</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Vendors that a component must have to match the filter.
If None or empty, components with any vendor name match the filter.</p></li>
<li><p><strong>names</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Names that a component must have to match the filter.
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">com.vmware.esx.settings.component</span></code>. When methods return a value
of this class as a return value, the attribute will contain
If None or empty, components with any name will match the filter.</p></li>
<li><p><strong>versions</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Versions that a component must have to match the filter.
If None or empty, components with any version will match the
filter.</p></li>
<li><p><strong>min_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>) – Minimum version of the component that can match the filter.
If <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code>, only components with version greater than or equal
to the given version match the filter.</p></li>
<li><p><strong>bundle_types</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType"title="com.vmware.esx.settings.depot_content_client.Components.ComponentBundleType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Components.ComponentBundleType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Component bundle types that a component must have to match the
filter.
If None or empty, all components will match the filter.</p></li>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.component'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</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">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">versions</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.depot_content_client.Components.Summary"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>vendor</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Vendor of the component.</p></li>
<li><p><strong>versions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.ComponentVersionSummary"title="com.vmware.esx.settings.depot_content_client.Components.ComponentVersionSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Components.ComponentVersionSummary</span></code></a>) – Summary information about the versions of this component. These are
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UrgencyType</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.depot_content_client.Components.UrgencyType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Components.UrgencyType</span></code> class defines possible values of urgencies
for a component.</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">UrgencyType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CRITICAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UrgencyType(string='CRITICAL')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.CRITICAL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">GENERAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UrgencyType(string='GENERAL')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.GENERAL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">IMPORTANT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UrgencyType(string='IMPORTANT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.IMPORTANT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">LOW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UrgencyType(string='LOW')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.LOW"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MODERATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">UrgencyType(string='MODERATE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depot_content_client.Components.UrgencyType.MODERATE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">filter</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.depot_content_client.Components.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of currently available components in the depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.FilterSpec"title="com.vmware.esx.settings.depot_content_client.Components.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Components.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The specification of matching components.
If None, the behavior is equivalent to a
<aclass="reference internal"href="#com.vmware.esx.settings.depot_content_client.Components.FilterSpec"title="com.vmware.esx.settings.depot_content_client.Components.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Components.FilterSpec</span></code></a> with all attributes None, which
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depot_content_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.depot_content_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-depots-client-module"></span><h2>com.vmware.esx.settings.depots_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.depots_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings.depots_client</span></code> module provides classes to manage
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depots_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Offline</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.depots_client.Offline"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline</span></code> class provides methods to manage offline 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>
<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.settings.depots_client.Offline.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.settings.depots_client.Offline.ConnectionSpec.AuthenticationType"title="com.vmware.esx.settings.depots_client.Offline.ConnectionSpec.AuthenticationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.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.settings.depots_client.Offline.HostCredentials"title="com.vmware.esx.settings.depots_client.Offline.HostCredentials"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.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.settings.depots_client.Offline.ConnectionSpec.AuthenticationType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.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.settings.depots_client.Offline.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.settings.depots_client.Offline.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD"title="Permalink to this definition">¶</a></dt>
<dd><p>Connect to host using host’s credentials class.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</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.depots_client.Offline.CreateResult"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">source_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">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file_id</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.depots_client.Offline.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.CreateSpec</span></code> class defines the information used to create a
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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the depot.
If None, the description will be empty.</p></li>
<li><p><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType"title="com.vmware.esx.settings.depots_client.Offline.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.SourceType</span></code></a>) – Type of the source from which offline bundle is obtained.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot from which content should be retrieved.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"title="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Offline.SourceType.PULL</span></code></a>.</p></li>
<li><p><strong>file_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
uploaded.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"title="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Offline.SourceType.PUSH</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DepotExtractInfo</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_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">result</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.depots_client.Offline.DepotExtractInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.DepotExtractInfo</span></code> class contains attributes that describe
the extracted 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>notifications</strong> (<aclass="reference internal"href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications"title="com.vmware.esx.settings_client.Notifications"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications returned by the extractDepot operation.</p></li>
<li><p><strong>software_spec</strong> (<aclass="reference internal"href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareSpec"title="com.vmware.esx.settings_client.SoftwareSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.SoftwareSpec</span></code></a>) – Software specification of the extracted depot.</p></li>
<li><p><strong>result</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.CreateResult"title="com.vmware.esx.settings.depots_client.Offline.CreateResult"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.CreateResult</span></code></a>) – The information about the created offline depot.</p></li>
<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.settings.depots_client.Offline.HostCredentials"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.HostCredentials</span></code> class contains attributes that describe the
host’s username, password, port number and ssl thumbprint to be used when
connecting to the host using USERNAME_PASSWORD option in the class.</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>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
<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
<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
<codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Offline.create_from_host()</span></code> method SHA1 hash of the host’s SSL
certificate.
If None, <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Offline.create_from_host()</span></code> method throws
UnverifiedPeer with the expected thumbprint as data.</p></li>
<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">description</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_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">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file_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">create_time</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.depots_client.Offline.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.Info</span></code> class defines the information regarding an offline
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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the depot. If not set during import, it will be
empty.</p></li>
<li><p><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType"title="com.vmware.esx.settings.depots_client.Offline.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.SourceType</span></code></a>) – Type of the source from which offline depot is obtained.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot from which content is retrieved.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"title="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Offline.SourceType.PULL</span></code></a>.</p></li>
<li><p><strong>file_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
uploaded.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"title="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Offline.SourceType.PUSH</span></code></a>.</p></li>
<li><p><strong>create_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time when the depot was created.</p></li>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.depots.offline'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SourceType</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.depots_client.Offline.SourceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.SourceType</span></code> class defines possible values of sources for the
offline depot.</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">SourceType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">PULL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='PULL')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"title="Permalink to this definition">¶</a></dt>
<dd><p>Content is pulled from the URL location. The URL scheme of the value in
{\@link CreateSpec#location) can be http, https or file.</p>
<codeclass="sig-name descname"><spanclass="pre">PUSH</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='PUSH')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"title="Permalink to this definition">¶</a></dt>
<dd><p>Content was previously uploaded using the file upload enpoint present on
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">source_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">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file_id</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.depots_client.Offline.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Offline.Summary</span></code> class defines the summary information regarding an
offline 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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the depot. If not set during import, it will be
empty.</p></li>
<li><p><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType"title="com.vmware.esx.settings.depots_client.Offline.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.SourceType</span></code></a>) – Type of the source from which offline depot is obtained.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot from which content is retrieved.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"title="com.vmware.esx.settings.depots_client.Offline.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Offline.SourceType.PULL</span></code></a>.</p></li>
<li><p><strong>file_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
uploaded.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"title="com.vmware.esx.settings.depots_client.Offline.SourceType.PUSH"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Offline.SourceType.PUSH</span></code></a>.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create_from_host_task</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.settings.depots_client.Offline.create_from_host_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Extract the current software specification applied to the host and
import it into the depot. Returns details about the current software
specification applied to the host. The result of this operation can be
queried by calling the cis/tasks/{task-id} where the task-id is the
response of this operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.ConnectionSpec"title="com.vmware.esx.settings.depots_client.Offline.ConnectionSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.ConnectionSpec</span></code></a>) – ConnectionSpec connection spec for the host.</p>
<codeclass="sig-name descname"><spanclass="pre">create_task</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.settings.depots_client.Offline.create_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Imports a new offline software depot. This will also import the
metadata and payloads from this offline depot. The returned task will
fail and no offline depot would be created if there are any issues
during import. The result of this operation can be queried by calling
the cis/tasks/{task-id} where the task-id is the response of this
operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.CreateSpec"title="com.vmware.esx.settings.depots_client.Offline.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.CreateSpec</span></code></a>) – Specification to import an offline depot.</p>
If the depot content already exists. The value of the data
attribute of <aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will
be a class that contains existing depot identifier as part of depot
attribute defined in <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Offline.CreateResult"title="com.vmware.esx.settings.depots_client.Offline.CreateResult"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Offline.CreateResult</span></code></a>.</p>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method removes content of an imported offline
depot from vLCM completely. Note: The non task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method
has been deprecated. It deletes only the record of depot from the list
of imported offline software depots, instead of removing the depot’s
content from vLCM.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the depot to be removed.
The parameter must be an identifier for the resource type:
If the content of depot to be deleted is used in some baseline or
desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
baselines and desired states. This error is applicable to the
If there some unknown internal error. The accompanying error
message will give more details about the failure. For task-based
<codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method, once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
DeleteResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">delete_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.delete_task"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method removes content of an imported offline
depot from vLCM completely. Note: The non task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method
has been deprecated. It deletes only the record of depot from the list
of imported offline software depots, instead of removing the depot’s
content from vLCM.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the depot to be removed.
The parameter must be an identifier for the resource type:
If the content of depot to be deleted is used in some baseline or
desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
baselines and desired states. This error is applicable to the
If there some unknown internal error. The accompanying error
message will give more details about the failure. For task-based
<codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method, once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
DeleteResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the information about an imported offline software depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the depot.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Offline.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns currently imported offline software depots.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depots_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Online</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.depots_client.Online"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Online</span></code> class provides methods to manage online 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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</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.depots_client.Online.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Online.CreateSpec</span></code> class defines the information used to create a
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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the depot.
If None, the description will be empty.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot. It should be the location to the index.xml
for the depot.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether this depot is enabled or not. Disabling the
depot doesn’t delete its cached metadata and payloads. It will not
<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">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">system_defined</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.depots_client.Online.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Online.Info</span></code> class defines the information regarding a 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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the depot. It will be an empty string if no
description was provided during create.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether this depot is enabled or not.</p></li>
<li><p><strong>system_defined</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate if the depot is system defined. System defined
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.depots.online'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">system_defined</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.depots_client.Online.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Online.Summary</span></code> class defines the summary information regarding a
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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the depot. It will be an empty string if no
description was provided during create.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether this depot is enabled or not.</p></li>
<li><p><strong>system_defined</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag to indicate if the depot is system defined. System defined
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</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.depots_client.Online.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Online.UpdateSpec</span></code> class defines the information used to update 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>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether this depot is enabled or not. Disabling the
depot doesn’t delete its cached metadata and payloads. It will not
be refreshed next time depots are re-synced.
If None, enabled flag is not updated.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the depot.
<codeclass="sig-name descname"><spanclass="pre">create</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.settings.depots_client.Online.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a new online software depot to the list of currently configured
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method removes content of a user-imported
online depot from vLCM completely. As a result, the URL of the
user-imported online depot will also be removed. Note: 1. To remove
content of system-defined online depots, use <codeclass="docutils literal notranslate"><spanclass="pre">flush</span></code> method. 2. The
non task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method has been deprecated. It only deletes
the record of depot from the list of imported online software depots,
instead of removing the depot’s content from the system.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the depot to be removed.
The parameter must be an identifier for the resource type:
If the content of depot to be deleted is used in some baseline or
desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
baselines and desired states. This error is applicable to the
If there some unknown internal error. The accompanying error
message will give more details about the failure. For task-based
<codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method, once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
DeleteResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">delete_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.delete_task"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method removes content of a user-imported
online depot from vLCM completely. As a result, the URL of the
user-imported online depot will also be removed. Note: 1. To remove
content of system-defined online depots, use <codeclass="docutils literal notranslate"><spanclass="pre">flush</span></code> method. 2. The
non task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method has been deprecated. It only deletes
the record of depot from the list of imported online software depots,
instead of removing the depot’s content from the system.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the depot to be removed.
The parameter must be an identifier for the resource type:
If the content of depot to be deleted is used in some baseline or
desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
baselines and desired states. This error is applicable to the
If there some unknown internal error. The accompanying error
message will give more details about the failure. For task-based
<codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method, once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
DeleteResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">flush_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.flush_task"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">flush</span></code> method removes content of a system-defined
online depot from vLCM completely. As a result, the system-defined
online depot will be disabled. Note: To remove content of user-imported
online depots, use the task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the depot to be removed.
The parameter must be an identifier for the resource type:
If the content of depot to be deleted is used in some baseline or
desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
If there some unknown internal error. The accompanying error
message will give more details about the failure. <codeclass="docutils literal notranslate"><spanclass="pre">flush</span></code> is a
task-based method. Once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
FlushResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the information about a currently configured online software
depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the depot.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of currently configured online software depots.</p>
<codeclass="sig-name descname"><spanclass="pre">update</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">depot</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Online.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a currently configured online software
depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>depot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the depot to be updated.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depots_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.depots_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depots_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SyncSchedule</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.depots_client.SyncSchedule"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SyncSchedule</span></code> class provides methods to manage Schedule of Online
Software Depot sync.</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">DayOfWeek</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.depots_client.SyncSchedule.DayOfWeek"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SyncSchedule.DayOfWeek</span></code> class contains the supported days of the
week.</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">DayOfWeek</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FRIDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='FRIDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.FRIDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MONDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='MONDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.MONDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SATURDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='SATURDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.SATURDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUNDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='SUNDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.SUNDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">THURSDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='THURSDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.THURSDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TUESDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='TUESDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.TUESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WEDNESDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='WEDNESDAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek.WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Recurrence</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.depots_client.SyncSchedule.Recurrence"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence</span></code> class contains the supported values for how
often to sync from online or UMDS depots.</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">Recurrence</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DAILY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='DAILY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">HOURLY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='HOURLY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MONTHLY_BY_DAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='MONTHLY_BY_DAY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WEEKLY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='WEEKLY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Schedule</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">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">skip</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">minute</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hour</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">day_of_month</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">day_of_week</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.depots_client.SyncSchedule.Schedule"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SyncSchedule.Schedule</span></code> class defines a schedule.</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.depots_client.SyncSchedule.Recurrence"title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence</span></code></a>) – Frequency of the schedule.</p></li>
<li><p><strong>skip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This determines the units of <codeclass="docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence</span></code> to skip
before the scheduled task runs again. For example, value of 1 for
HOURLY type means the scheduled task runs every 2 hours. The value
must be within the range 0 to 998.
If None, no unit is skipped.</p></li>
<li><p><strong>minute</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Minute at which schedule should be run. The value must be within
the range 0 to 59.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY"title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.HOURLY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence.HOURLY</span></code></a>,
<li><p><strong>hour</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Hour at which schedule should be run. The value must be within the
range 0 to 23.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY"title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.DAILY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence.DAILY</span></code></a>,
<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence.WEEKLY</span></code></a>, or
<li><p><strong>day_of_month</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Day at which schedule should be run. The value must be within the
range 1 to 31. If the value exceeds the total number of days in the
month, the schedule will run on the last day of the month.
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.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY"title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.MONTHLY_BY_DAY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence.MONTHLY_BY_DAY</span></code></a>.</p></li>
<li><p><strong>day_of_week</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek"title="com.vmware.esx.settings.depots_client.SyncSchedule.DayOfWeek"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SyncSchedule.DayOfWeek</span></code></a>) – Day of the week when schedule should be run
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.depots_client.SyncSchedule.Recurrence.WEEKLY"title="com.vmware.esx.settings.depots_client.SyncSchedule.Recurrence.WEEKLY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SyncSchedule.Recurrence.WEEKLY</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Spec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">schedule</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">email_addresses</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.depots_client.SyncSchedule.Spec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SyncSchedule.Spec</span></code> class defines the information regarding the sync
schedule.</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>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether automatic sync is enabled or not</p></li>
<li><p><strong>schedule</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Schedule"title="com.vmware.esx.settings.depots_client.SyncSchedule.Schedule"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SyncSchedule.Schedule</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The schedule to check for new updates.
If None the schedule must be disabled.</p></li>
<li><p><strong>email_addresses</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Email addresses to which the notification will be sent. If empty,
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.SyncSchedule.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the currently configured software depot sync schedule.</p>
<codeclass="sig-name descname"><spanclass="pre">set</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</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.depots_client.SyncSchedule.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the software depot sync schedule.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.SyncSchedule.Spec"title="com.vmware.esx.settings.depots_client.SyncSchedule.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SyncSchedule.Spec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information of the software depot sync schedule.
If None, it will be reset to the default schedule, which is daily
at a random hour chosen when this API is called.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.depots_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Umds</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.depots_client.Umds"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Umds</span></code> class provides methods to manage the VMware vSphere Update
Manager Download Service (UMDS) software depot used during ESX lifecycle
management. This is the depot downloaded using UMDS. If the UMDS depot is
specified, then online depots are ignored and data is downloaded only from
the UMDS depot.</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">Info</span></code><spanclass="sig-paren">(</span><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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</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.depots_client.Umds.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Umds.Info</span></code> class defines the information regarding the UMDS 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>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Description of the depot. It will be an empty string if no
description was provided during create.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Flag indicating whether or not this depot is enabled.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">SetSpec</span></code><spanclass="sig-paren">(</span><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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">location</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.depots_client.Umds.SetSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the depot.
If None, the description will be empty.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether or not this depot should be enabled.
Disabling the depot doesn’t delete its cached metadata and
payloads. It will not be refreshed next time depots are re-synced.
If None, the depot will be enabled.</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the depot. It should be the location to the index.xml
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpdateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</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.depots_client.Umds.UpdateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Umds.UpdateSpec</span></code> class defines the information used to update the
UMDS 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>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether or not this depot is enabled. Disabling the
depot doesn’t delete its cached metadata and payloads. It will not
be refreshed next time depots are re-synced.
If None, the enabled flag is not updated.</p></li>
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the depot.
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Umds.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method removes content of the UMDS depot from
vLCM completely. Note: The non task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method has been
deprecated. It deletes only the record of UMDS depot from database,
instead of removing the content of UMDS depot from vLCM.</p>
If the content of UMDS depot to be deleted is used in some baseline
or desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
baselines and desired states. This error is applicable to the
If there some unknown internal error. The accompanying error
message will give more details about the failure. For task-based
<codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method, once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
DeleteResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">delete_task</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Umds.delete_task"title="Permalink to this definition">¶</a></dt>
<dd><p>The task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method removes content of the UMDS depot from
vLCM completely. Note: The non task-based <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method has been
deprecated. It deletes only the record of UMDS depot from database,
instead of removing the content of UMDS depot from vLCM.</p>
If the content of UMDS depot to be deleted is used in some baseline
or desired state. The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
PrecheckResult class that lists the information of affected
baselines and desired states. This error is applicable to the
If there some unknown internal error. The accompanying error
message will give more details about the failure. For task-based
<codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> method, once the task is started, it does NOT stop if
encountering an error. Instead, it will continuously run to
completion. In this case, the value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be the
DeleteResult class that lists all the errors encountered.</p>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.depots_client.Umds.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the information about a currently configured UMDS software depot.</p>
<codeclass="sig-name descname"><spanclass="pre">set</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.settings.depots_client.Umds.set"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets or overwrites information about the UMDS software depot.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.depots_client.Umds.SetSpec"title="com.vmware.esx.settings.depots_client.Umds.SetSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Umds.SetSpec</span></code></a>) – Specification to set the UMDS depot.</p>
<codeclass="sig-name descname"><spanclass="pre">update</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.settings.depots_client.Umds.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Updates the configuration of a currently configured UMDS software
<spanid="com-vmware-esx-settings-hardware-support-client-module"></span><h2>com.vmware.esx.settings.hardware_support_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.hardware_support_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.hardware_support_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Managers</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.hardware_support_client.Managers"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Managers</span></code> class provides methods to list Hardware Support Manager
(HSM) for a given vCenter.</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">HardwareSupportManagerInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">manager</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>, <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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support_client.Managers.HardwareSupportManagerInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>manager</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Hardware Support Manager (HSM) (e.g. “Frobozz Hardware
Support Manager”)
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.setting.hardware_support.manager</span></code>. When methods
return a value of this class as a return value, the attribute will
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User-intelligible description of the HSM (e.g. “Front end for
Frobozz so-and-so management system”)</p></li>
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – UI label for HSM, derived from HSM extension’s description’s
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hardware_support_client.Managers.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the list of registered Hardware Support Managers (HSMs) in the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.hardware_support_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.hardware_support_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-hosts-client-module"></span><h2>com.vmware.esx.settings.hosts_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.hosts_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings.hosts_client</span></code> module provides classes to manage
desired state configuration and software for a standalone ESX host.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.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.settings.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 manage desired software
specification of a standalone ESX 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>
<codeclass="sig-name descname"><spanclass="pre">scan_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.hosts_client.Software.scan_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Scans the host against the host’s desired state.. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the
task-id is the response of this operation.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>host</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the host.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.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.settings.hosts_client.StubFactory"title="Permalink to this definition">¶</a></dt>
