<spanid="com-vmware-esx-settings-clusters-package"></span><h1>com.vmware.esx.settings.clusters package<aclass="headerlink"href="#module-com.vmware.esx.settings.clusters"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-configuration-client-module"></span><h2>com.vmware.esx.settings.clusters.configuration_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.clusters.configuration_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.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ArrayComplianceValue</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">bool_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">long_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">double_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">str_arr</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.configuration_client.ArrayComplianceValue"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValueType</span></code></a>) – Type of the configuration in drift.</p></li>
<li><p><strong>bool_arr</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.BooleanComplianceValueArray"title="com.vmware.esx.settings.clusters.configuration_client.BooleanComplianceValueArray"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BooleanComplianceValueArray</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a boolean array of configuration values.
This field is None if the type is not BOOLEAN.</p></li>
<li><p><strong>long_arr</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.LongComplianceValueArray"title="com.vmware.esx.settings.clusters.configuration_client.LongComplianceValueArray"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LongComplianceValueArray</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in an integer(16 bit or 32 bit or 64 bit) array
of configuration values.
This field is None if the type is not Long.</p></li>
<li><p><strong>double_arr</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.DoubleComplianceValueArray"title="com.vmware.esx.settings.clusters.configuration_client.DoubleComplianceValueArray"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DoubleComplianceValueArray</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a floating point(float or double) array of
configuration values.
This field is None if the type is not DOUBLE.</p></li>
<li><p><strong>str_arr</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.StringComplianceValueArray"title="com.vmware.esx.settings.clusters.configuration_client.StringComplianceValueArray"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StringComplianceValueArray</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a strings array of configuration values.
This field is None if the type is neither STRING nor SECRET.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BooleanComplianceValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_value</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.configuration_client.BooleanComplianceValue"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BooleanComplianceValueArray</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_arr</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.configuration_client.BooleanComplianceValueArray"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">CheckComplianceResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_results</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_status</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.configuration_client.CheckComplianceResult"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComplianceValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">is_array</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">array_value</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.configuration_client.ComplianceValue"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code> class contains attributes that describes the drift
in an ESXi host configuration from desired value. This structure is used to
describe either a change in configuration value(set) or addition of
configuration or deletion of a configuration. When used to describe
addition or deletion of a configuration, only the path, type and isArray
fields are set, and type is always expected to be USER_DATA. When used to
describe a set operation, hostValue and desiredValue would only be set if
drift is in a property that is of primitive type.</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>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Full path to the configuration at drift within the desired
document.</p></li>
<li><p><strong>is_array</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if the configuration in drift is an array.</p></li>
<li><p><strong>value</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.PrimitiveComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.PrimitiveComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PrimitiveComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a primitive data type value.
This field is None if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ComplianceValue.is_array</span></code> is true.</p></li>
<li><p><strong>array_value</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ArrayComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ArrayComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ArrayComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a array of primitive type values.
This field is None if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ComplianceValue.is_array</span></code> is false.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ComplianceValueType</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.configuration_client.ComplianceValueType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ComplianceValueType</span></code> class represents the type of configuration in
drift.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValueType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">BINARY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='BINARY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.BINARY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">BOOLEAN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='BOOLEAN')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.BOOLEAN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">DOUBLE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='DOUBLE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.DOUBLE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">LONG</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='LONG')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.LONG"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the value is a integer(16 or 32 or 64 bit).</p>
<codeclass="sig-name descname"><spanclass="pre">SECRET</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='SECRET')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.SECRET"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">STRING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='STRING')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.STRING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">USER_DATA</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ComplianceValueType(string='USER_DATA')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType.USER_DATA"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the value is a dynamic user defined structure.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DoubleComplianceValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_value</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.configuration_client.DoubleComplianceValue"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DoubleComplianceValueArray</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_arr</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.configuration_client.DoubleComplianceValueArray"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostCheckComplianceResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compliant</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sets</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">adds</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">deletes</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.configuration_client.HostCheckComplianceResult"title="Permalink to this definition">¶</a></dt>
<p>This <codeclass="docutils literal notranslate"><spanclass="pre">CheckComplianceResult</span></code> class contains attributes that describe the
compliance of an individual host with the desired configuration.</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>compliant</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – This boolean flag indicates whether the ESXi host is in compliance
with desired configuration.</p></li>
<li><p><strong>sets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of configuration drifts represented by
<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code></a>. Each describing a configuration whose
value on ESXi host is different to that in the desired document.
This field is None if the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostCheckComplianceResult.compliant</span></code> is set to true.</p></li>
<li><p><strong>adds</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of configuration drifts represented by
<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code></a>. Each describing a configuration that is
present in the desired document but absent on the ESXi host.
This field is None if the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostCheckComplianceResult.compliant</span></code> is set to true or if
there are no additions required to make the ESXi host compliant.</p></li>
<li><p><strong>deletes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of configuration drifts represented by
<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValue</span></code></a>. Each describing a configuration that is
present on the ESXi host but absent in the desired document.
This field is None if the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostCheckComplianceResult.compliant</span></code> is set to true or if
there are no deletions required to make the ESXi host compliant.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostImpactInfo</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">impact</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.configuration_client.HostImpactInfo"title="Permalink to this definition">¶</a></dt>
<p>The impact status/result for an individual host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus"title="com.vmware.esx.settings.clusters.configuration_client.HostStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostStatus</span></code></a>) – The status of the impact request for this host.</p></li>
<li><p><strong>impact</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.HostImpactResult"title="com.vmware.esx.settings.clusters.configuration_client.HostImpactResult"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostImpactResult</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If the operation was successfully executed on the host, the results
are stored in this field.
This field is None if the host could not be contacted successfully.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostImpactResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">compliant</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">impact</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">info</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.HostImpactResult"title="Permalink to this definition">¶</a></dt>
<p>This <codeclass="docutils literal notranslate"><spanclass="pre">HostImpactResult</span></code> class contains attributes that describe the
result of the Impact API on the host.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>compliant</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – This boolean flag indicates whether the ESXi host is in compliance
with desired configuration.</p></li>
<li><p><strong>impact</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType"title="com.vmware.esx.settings.clusters.configuration_client.ImpactType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ImpactType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This field indicates the ESXi host impact on applying the desired
configuration.
This field is None if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostImpactResult.compliant</span></code> is set to
true.</p></li>
<li><p><strong>info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactInfo"title="com.vmware.esx.settings.clusters.configuration_client.ImpactInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ImpactInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This field represents the list of impact information describing the
configuration changes needed on the host to reach the desired
state.
This field is None if <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">HostImpactResult.compliant</span></code> is set to
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostStatus</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">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.configuration_client.HostStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HostStatus</span></code> class contains attributes that describe the status of an
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.configuration_client.HostStatus.Status"title="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostStatus.Status</span></code></a>) – The status of the method.</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.configuration_client.HostStatus.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HostStatus.Status</span></code> class contains the possible different status
codes that can be returned while trying to perform an operation on the
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.configuration_client.HostStatus.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.configuration_client.HostStatus.Status.OK"title="Permalink to this definition">¶</a></dt>
<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.configuration_client.HostStatus.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.configuration_client.HostStatus.Status.TIMED_OUT"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ImpactInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactInfo"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ImpactResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">impact</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.configuration_client.ImpactResult"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ImpactType</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.configuration_client.ImpactType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ImpactType</span></code> class contains information about the impact of applying
desired configuration on the ESXi 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 <aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType"title="com.vmware.esx.settings.clusters.configuration_client.ImpactType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ImpactType</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">MAINTENANCE_MODE_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ImpactType(string='MAINTENANCE_MODE_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType.MAINTENANCE_MODE_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Host requires maintenance mode to reach the desired state.</p>
<codeclass="sig-name descname"><spanclass="pre">NO_IMPACT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ImpactType(string='NO_IMPACT')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType.NO_IMPACT"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">REBOOT_REQUIRED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ImpactType(string='REBOOT_REQUIRED')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType.REBOOT_REQUIRED"title="Permalink to this definition">¶</a></dt>
<dd><p>Host requires reboot to reach the desired state.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LongComplianceValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_value</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.configuration_client.LongComplianceValue"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">LongComplianceValue</span></code> class contains attributes that describe a long
value in drift. This struture captures the desired value and the host value
for the drift.</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_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Long value on ESXi host.</p></li>
<li><p><strong>desired_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Long value in desired document.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LongComplianceValueArray</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_arr</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.configuration_client.LongComplianceValueArray"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">PrimitiveComplianceValue</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">bool_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">long_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">double_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">str_value</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.configuration_client.PrimitiveComplianceValue"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PrimitiveComplianceValue</span></code> class contains attributes that describe
the drift in a primitive data type value. Depending on the primitive data
type of the configuration only one of the members in this structure is
populated.</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.configuration_client.ComplianceValueType"title="com.vmware.esx.settings.clusters.configuration_client.ComplianceValueType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComplianceValueType</span></code></a>) – Type of the configuration in drift.</p></li>
<li><p><strong>bool_value</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.BooleanComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.BooleanComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">BooleanComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a boolean configuration value.
This field is None if the type is not BOOLEAN.</p></li>
<li><p><strong>long_value</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.LongComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.LongComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LongComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in an integer(16 bit or 32 bit or 64 bit)
configuration value.
This field is None if the type is not Long.</p></li>
<li><p><strong>double_value</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.DoubleComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.DoubleComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DoubleComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a floating point(float or double)
configuration value.
This field is None if the type is not DOUBLE.</p></li>
<li><p><strong>str_value</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.configuration_client.StringComplianceValue"title="com.vmware.esx.settings.clusters.configuration_client.StringComplianceValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StringComplianceValue</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Describes the drift in a string configuration value.
This field is None if the type is neither STRING nor SECRET.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StringComplianceValue</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_value</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_value</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.configuration_client.StringComplianceValue"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StringComplianceValueArray</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">host_arr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">desired_arr</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.configuration_client.StringComplianceValueArray"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_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.configuration_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.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ValidationError</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</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.configuration_client.ValidationError"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ValidationError</span></code> class contains attributes that describes a
validation error in the configuration.</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>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Full path to the configuration or the property within the
configuration which was found to be invalid.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.configuration_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ValidationResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">valid</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">errors</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.configuration_client.ValidationResult"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-clusters-enablement-client-module"></span><h2>com.vmware.esx.settings.clusters.enablement_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.clusters.enablement_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.clusters.enablement_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.enablement_client.Software"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software</span></code> class provides methods to control whether the cluster is
managed with a single software specification.</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">CheckResult</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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckResult"title="Permalink to this definition">¶</a></dt>
<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">checks_to_skip</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.enablement_client.Software.CheckSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.CheckSpec</span></code> class contains information describing what
checks should be 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"><p><strong>checks_to_skip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType"title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Software.CheckType</span></code></a>) – Specifies the checks that should be skipped. If the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> is
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckType</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.enablement_client.Software.CheckType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.CheckType</span></code> class contains various checks to identify the
possibility to enable the feature that manages the cluster with a single
software specification.</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">CheckType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">SOFTWARE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckType(string='SOFTWARE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE"title="Permalink to this definition">¶</a></dt>
<dd><p>Perform host software check. This check is to report standalone VIBs (VIBs
which are not part of any component) and the features on the given cluster
that cannot coexist with the feature which manages the cluster with a
<codeclass="sig-name descname"><spanclass="pre">SOFTWARE_SPECIFICATION_EXISTENCE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckType(string='SOFTWARE_SPECIFICATION_EXISTENCE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE_SPECIFICATION_EXISTENCE"title="Permalink to this definition">¶</a></dt>
<dd><p>Perform cluster’s software specification existence check.</p>
<codeclass="sig-name descname"><spanclass="pre">STATELESSNESS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckType(string='STATELESSNESS')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.STATELESSNESS"title="Permalink to this definition">¶</a></dt>
<dd><p>Perform host statelessness check. This feature does not support stateless
<codeclass="sig-name descname"><spanclass="pre">VERSION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckType(string='VERSION')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VERSION"title="Permalink to this definition">¶</a></dt>
<dd><p>Perform host version check. This feature does not support hosts with
<codeclass="sig-name descname"><spanclass="pre">VUM_REMEDIATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">CheckType(string='VUM_REMEDIATION')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VUM_REMEDIATION"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">EnableSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">skip_software_check</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.enablement_client.Software.EnableSpec"title="Permalink to this definition">¶</a></dt>
<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">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.clusters.enablement_client.Software.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Software.Info</span></code> class contains information describing whether the
feature is enabled.</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>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Status of the feature enablement True if feature is enabled, false
<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><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.enablement_client.Software.check_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Checks the possibility to manage the cluster with a single 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">enable_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><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.enablement_client.Software.enable_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Enables the feature which manages the cluster with a single 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:
If feature enablement failed for the given cluster. 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
<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.enablement_client.Software.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether the given cluster is managed with a single 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:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.enablement_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.enablement_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-clusters-policies-client-module"></span><h2>com.vmware.esx.settings.clusters.policies_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.clusters.policies_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.clusters.policies_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Apply</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.policies_client.Apply"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Apply</span></code> class provides methods to configure the policies that will
impact how the software and configuration specification documents are
applied to an ESXi 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">Apply.ConfiguredPolicySpec</span></code> class contains attributes that describe
the policies configured to be used when the software and configuration
specification documents are applied to an ESXi 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>failure_action</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction"title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Apply.FailureAction</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – What action is to be taken if entering maintenance mode fails on a
given host of the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>pre_remediation_power_action</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction"title="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Apply.ConfiguredPolicySpec.PreRemediationPowerAction</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies what should be done to the power state of the VM before
entering maintenance mode.
If None, configured value would be unset.</p></li>
<li><p><strong>enable_quick_boot</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable Quick Boot during remediation in the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>disable_dpm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Disable DPM on the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>disable_hac</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Disable HA Admission control on the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>evacuate_offline_vms</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Evacuate powered off/suspended VMs when attempting maintenance
mode.
If None, configured value would be unset.</p></li>
<li><p><strong>enforce_hcl_validation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enforce Hcl validation, when applicable, to prevent remediation if
hardware compatibility issues are found. This attribute was added
in vSphere API 7.0.1.0.
If None, hardware compatibility issues will not prevent
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">PreRemediationPowerAction</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.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Apply.ConfiguredPolicySpec.PreRemediationPowerAction</span></code> class defines
the possible actions to be taken, before entering maintenance mode.</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">PreRemediationPowerAction</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DO_NOT_CHANGE_VMS_POWER_STATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">POWER_OFF_VMS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PreRemediationPowerAction(string='POWER_OFF_VMS')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.POWER_OFF_VMS"title="Permalink to this definition">¶</a></dt>
<dd><p>Power off VMs before entering maintenance mode.</p>
<codeclass="sig-name descname"><spanclass="pre">SUSPEND_VMS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PreRemediationPowerAction(string='SUSPEND_VMS')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS"title="Permalink to this definition">¶</a></dt>
<dd><p>Suspend VMs before entering maintenance mode</p>
<codeclass="sig-name descname"><spanclass="pre">SUSPEND_VMS_TO_MEMORY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY"title="Permalink to this definition">¶</a></dt>
<dd><p>Suspend VMs to Memory before entering maintenance mode. This class
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">FailureAction</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">action</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">retry_delay</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">retry_count</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.policies_client.Apply.FailureAction"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Apply.FailureAction</span></code> class contains attributes that describe the
actions to be taken when entering maintenance mode fails on a single host
within the 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>action</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action"title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Apply.FailureAction.Action</span></code></a>) – What action (FAIL, RETRY) is to be taken if entering maintenance
mode fails on a single host within the cluster.</p></li>
<li><p><strong>retry_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Time to wait to retry the failed operation in seconds.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">action</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Apply.FailureAction.Action.RETRY</span></code></a>.</p></li>
<li><p><strong>retry_count</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Number of times to retry the failed operation.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">action</span></code> is <aclass="reference internal"href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Apply.FailureAction.Action.RETRY</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Action</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.policies_client.Apply.FailureAction.Action"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Apply.FailureAction.Action</span></code> class defines the actions to be taken
when entering maintenance mode fails on a single host 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">Action</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FAIL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Action(string='FAIL')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.FAIL"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RETRY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Action(string='RETRY')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"title="Permalink to this definition">¶</a></dt>
<dd><p>Retry the task <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Apply.FailureAction.retry_count</span></code> number of times on
the failed host after <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Apply.FailureAction.retry_delay</span></code>.</p>
<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.policies_client.Apply.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the configured policy that has been set for the cluster.</p>
<codeclass="sig-name descname"><spanclass="pre">set</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.policies_client.Apply.set"title="Permalink to this definition">¶</a></dt>
<dd><p>This API will set the configured policy specification for the cluster.</p>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec"title="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Apply.ConfiguredPolicySpec</span></code></a>) – The policy that needs to be configured.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.policies_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.policies_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-esx-settings-clusters-software-client-module"></span><h2>com.vmware.esx.settings.clusters.software_client module<aclass="headerlink"href="#module-com.vmware.esx.settings.clusters.software_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.clusters.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AddOn</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.software_client.AddOn"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AddOn</span></code> class provides methods to manage desired OEM add-on
specification for a given 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>
<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.clusters.software_client.AddOn.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<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.software_client.AddOn.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the desired OEM add-on specification 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 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.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">BaseImage</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.software_client.BaseImage"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">BaseImage</span></code> class provides methods to manage desired ESX base image.</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">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.clusters.software_client.BaseImage.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<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.software_client.BaseImage.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the desired base-image specification set for 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 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.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Commits</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.software_client.Commits"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Commits</span></code> class provides methods to manage committed changes to
desired software document.</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">author</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_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">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">apply_status</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.software_client.Commits.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Commits.Info</span></code> class defines the information about software draft.</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>author</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Author of the commit.</p></li>
<li><p><strong>commit_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Creation time of the commit.</p></li>
<li><p><strong>apply_status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType"title="com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Commits.Info.ApplyStatusType</span></code></a>) – Apply status of the commit.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ApplyStatusType</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.software_client.Commits.Info.ApplyStatusType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Commits.Info.ApplyStatusType</span></code> class defines possible values
regarding the application of this commit.</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">ApplyStatusType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">APPLIED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplyStatusType(string='APPLIED')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType.APPLIED"title="Permalink to this definition">¶</a></dt>
<dd><p>Commit has been applied to the cluster.</p>
<codeclass="sig-name descname"><spanclass="pre">NOT_APPLIED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ApplyStatusType(string='NOT_APPLIED')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType.NOT_APPLIED"title="Permalink to this definition">¶</a></dt>
<dd><p>Commit hasn’t been applied to the cluster.</p>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.commit'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Commits.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">commit</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Commits.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the information about a specific commit.</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:
<li><p><strong>commit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the specific commit.
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.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Compliance</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.software_client.Compliance"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Compliance</span></code> class provides methods to get the last software
compliance result for 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>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'ClusterComputeResource'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Compliance.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<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.software_client.Compliance.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the compliance state for the 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 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.software_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.clusters.software_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 desired component
specification for 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>
<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.clusters.software_client.Components.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">component</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Components.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the component version for the given component in 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">list</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.software_client.Components.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of components in the 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:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Drafts</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.software_client.Drafts"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Drafts</span></code> class provides methods to manage working copy of software
documents.</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">CommitSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.CommitSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Drafts.CommitSpec</span></code> class contains attributes that are used to create
a new commit.</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>message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Message to include with the commit.
<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">owners</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.software_client.Drafts.FilterSpec"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ImportSpec</span></code><spanclass="sig-paren">(</span><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">software_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.clusters.software_client.Drafts.ImportSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Drafts.ImportSpec</span></code> class defines the information used to import the
desired software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType"title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Drafts.SourceType</span></code></a>) – Type of the source to import the desired software specification</p></li>
<li><p><strong>location</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Location of the software specification file to be imported.
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.clusters.software_client.Drafts.SourceType.PULL"title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Drafts.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.clusters.software_client.Drafts.SourceType.PUSH"title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PUSH"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Drafts.SourceType.PUSH</span></code></a>.</p></li>
<li><p><strong>software_spec</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The JSON string representing the desired software specification.
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.clusters.software_client.Drafts.SourceType.JSON_STRING"title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.JSON_STRING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Drafts.SourceType.JSON_STRING</span></code></a>.</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">metadata</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</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.software_client.Drafts.Info"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Metadata</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">owner</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">creation_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.clusters.software_client.Drafts.Metadata"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Drafts.Metadata</span></code> class defines the metadata information about
software draft.</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>owner</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Owner of the software draft.</p></li>
<li><p><strong>status</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType"title="com.vmware.esx.settings.clusters.software_client.Drafts.StatusType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Drafts.StatusType</span></code></a>) – Status of the software draft.</p></li>
<li><p><strong>creation_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Creation time of the software draft.</p></li>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.draft'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.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.clusters.software_client.Drafts.SourceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Drafts.SourceType</span></code> class defines possible values of sources to
import software specification.</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">CURRENT_SERIES_RECOMMENDATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='CURRENT_SERIES_RECOMMENDATION')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Content is from recommended image specification based on latest base image
patch or update of the current series. For example, a cluster’s current
desired base image is 7.0. Recommendation engine will look into any
recommendable image specification with 7.0 series base images available at
depot manager and try to recommend the highest version within 7.0 series if
possible. Let’s say in this example, depot manager has 7.0 patch a and 7.0
update 1 base images. Recommendation engine would first validate all
possible images based on 7.0 update 1. If it finds a valid one, it will
store the recommended content with that series. This enum value will point
to that stored recommended image content. Recommendations can be generated
<codeclass="sig-name descname"><spanclass="pre">JSON_STRING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='JSON_STRING')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.JSON_STRING"title="Permalink to this definition">¶</a></dt>
<dd><p>The string representing the content of the software specfication.</p>
<codeclass="sig-name descname"><spanclass="pre">LATEST_RECOMMENDATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='LATEST_RECOMMENDATION')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Content is from recommended image specification based on latest base image
version. Recommendations can be generated using {\@link:
<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.clusters.software_client.Drafts.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 #pullLocation) 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.clusters.software_client.Drafts.SourceType.PUSH"title="Permalink to this definition">¶</a></dt>
<dd><p>Content was previously uploaded using the file upload enpoint present on
<codeclass="sig-name descname"><spanclass="pre">SPECIFIED_BASE_IMAGE_RECOMMENDATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='SPECIFIED_BASE_IMAGE_RECOMMENDATION')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.SPECIFIED_BASE_IMAGE_RECOMMENDATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Content is from recommended image specification based on a specified base
image version. Recommendations can be generated using {\@link:
com.vmware.esx.settings.clusters.software.Recommendations#generate}. This
class attribute was added in vSphere API 7.0.2.0.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StatusType</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.software_client.Drafts.StatusType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Drafts.StatusType</span></code> class defines possible values of status of a
software draft.</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">StatusType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">INVALID</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StatusType(string='INVALID')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType.INVALID"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">VALID</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StatusType(string='VALID')</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType.VALID"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">metadata</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.software_client.Drafts.Summary"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ValidateResult</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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.ValidateResult"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">commit_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">draft</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.software_client.Drafts.commit_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Commits the specified draft as the 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:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.CommitSpec"title="com.vmware.esx.settings.clusters.software_client.Drafts.CommitSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Drafts.CommitSpec</span></code></a>) – The spec to be used to create the commit.</p></li>
If validation of the software document fails. 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 all the attributes defined in
<codeclass="sig-name descname"><spanclass="pre">create</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.software_client.Drafts.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new software draft from the desired document. It will be
deleted, when the draft is committed successfully. If a desired
document is missing, then this method will create an empty draft.</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">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">draft</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the software draft.</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:
<li><p><strong>draft</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the working copy of the document.
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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">draft</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the information about given software draft.</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">import_software_spec</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.software_client.Drafts.import_software_spec"title="Permalink to this definition">¶</a></dt>
<dd><p>Imports the desired software specification as a new draft. If a desired
document is missing, then this method will create an empty draft except
when the source type is of either
<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION"title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Drafts.SourceType.LATEST_RECOMMENDATION</span></code></a> or
<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION"title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION</span></code></a>, then
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound"title="com.vmware.vapi.std.errors_client.NotFound"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a> error is reported.
In addition, the exisiting draft will be overwritten when the source
type is of either <codeclass="docutils literal notranslate"><spanclass="pre">LATEST_RECOMMENDATION</span></code> or
If there is no cluster associated with <codeclass="docutils literal notranslate"><spanclass="pre">cluster</span></code> in the system or
if the source type of import specification is of either
<codeclass="docutils literal notranslate"><spanclass="pre">LATEST_RECOMMENDATION</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">CURRENT_SERIES_RECOMMENDATION</span></code>, and
a recommendation does not exist for the cluster. It was either
never generated or deleted due to changes in cluster state such as
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <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.clusters.software_client.Drafts.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns information about the software drafts for the specified cluster
that match the <aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec"title="com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Drafts.FilterSpec</span></code></a>.</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:
<li><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec"title="com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Drafts.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Filter to be applied while returning drafts.
<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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">draft</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.scan_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Scans all the hosts in the cluster against the software draft. 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:
<li><p><strong>draft</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">validate_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">draft</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Drafts.validate_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Validates the software draft. 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:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">EffectiveComponents</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.software_client.EffectiveComponents"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">EffectiveComponents</span></code> class provides methods to get effective list of
components.</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">list</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.software_client.EffectiveComponents.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the effective components for the 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 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.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HardwareSupport</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.software_client.HardwareSupport"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">HardwareSupport</span></code> class provides methods to manage a cluster’s
Hardware Support Package (HSP) configuration.</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">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.software_client.HardwareSupport.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a given cluster’s Hardware Support Package (HSP) configuration.</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:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Recommendations</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.software_client.Recommendations"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Recommendations</span></code> class provides methods to manage the generation and
retrieval of recommended image specs.</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">ExplanationDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">display_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">display_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">explanation</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.software_client.Recommendations.ExplanationDetails"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Recommendations.ExplanationDetails</span></code> class contains attributes to
describe the result of validation of desired software specification.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display name of an excluded image entity (base image, add-on etc.).</p></li>
<li><p><strong>display_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Display version of an excluded image entity (base image, add-on
etc.).</p></li>
<li><p><strong>explanation</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>) – List of explanations on why the image entity is excluded.</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">base_image_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.clusters.software_client.Recommendations.FilterSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Recommendations.FilterSpec</span></code> class contains attributes used to filter
the generated recommendations (see <codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Recommendations.generate()</span></code>) based
on a specified base image version. This class was added in vSphere API
7.0.2.0.</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>base_image_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>) – Base image version string is used in generating the specified base
image recommendations. Default recommendations are generated when
the value is empty. This attribute was added in vSphere API
<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">latest_recommendation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">current_series_recommendation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">specified_base_image_version_recommendation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">base_image_explanation_details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">check_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.clusters.software_client.Recommendations.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Recommendations.Info</span></code> class defines the information about the most
recent recommendation generation 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>latest_recommendation</strong> (<aclass="reference internal"href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo"title="com.vmware.esx.settings_client.SoftwareInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recommended image specification based on latest base image version.
None if no recommended image based on latest base image version is
available.</p></li>
<li><p><strong>current_series_recommendation</strong> (<aclass="reference internal"href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo"title="com.vmware.esx.settings_client.SoftwareInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recommended image specification based on latest base image patch or
update of the current series.
None if no recommended image based on latest base image patch or
update of the current series is available.</p></li>
<li><p><strong>specified_base_image_version_recommendation</strong> (<aclass="reference internal"href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo"title="com.vmware.esx.settings_client.SoftwareInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recommended image specification based on a specified base image
version. This attribute was added in vSphere API 7.0.2.0.
None if no recommendation image based on the specified base image
version is available.</p></li>
<li><p><strong>base_image_explanation_details</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Recommendations.ExplanationDetails"title="com.vmware.esx.settings.clusters.software_client.Recommendations.ExplanationDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendations.ExplanationDetails</span></code></a>) – Details about why some base images are excluded in latest and
current series recommendations. This is not applicable for
specified base image recommendations.</p></li>
<li><p><strong>check_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The most recent timestamp when check for recommended image is
launched.
None if no recommendation check has ever been launched.</p></li>
<codeclass="sig-name descname"><spanclass="pre">generate_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">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.clusters.software_client.Recommendations.generate_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Generates recommended software image spec(s) based on current desired
software spec. 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:
<li><p><strong>filter</strong> (<aclass="reference internal"href="#com.vmware.esx.settings.clusters.software_client.Recommendations.FilterSpec"title="com.vmware.esx.settings.clusters.software_client.Recommendations.FilterSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recommendations.FilterSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specification on how to filter recommendations based on a specified
base image version. This parameter was added in vSphere API
7.0.2.0.
If None, latest and current series recommendations are generated.</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.software_client.Recommendations.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns Information about the most recent recommendation generation
result.</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.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Solutions</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.software_client.Solutions"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Solutions</span></code> class provides methods to manage desired software
solution specifications for 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>
<codeclass="sig-name descname"><spanclass="pre">RESOURCE_TYPE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.esx.settings.solution'</span></em><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Solutions.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">delete_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">solution</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Solutions.delete_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the given solution from the desired software specification. The
deletion will be validated along with the entire software specification
before it is committed as new desired spec. 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 validation of the software document fails. 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 all the attributes defined in
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">solution</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.esx.settings.clusters.software_client.Solutions.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns components registered for the given solution in 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">list</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.software_client.Solutions.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns all solutions in the 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">set_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">solution</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.software_client.Solutions.set_task"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the components registered for the given solution in the desired
software specification. The task will set only one solution
specification at a time. Solution constraints would be validated with
the current desired software specification before it is committed as
new desired spec. 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 validation of the software document fails. 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 all the attributes defined in
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.esx.settings.clusters.software_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.software_client.StubFactory"title="Permalink to this definition">¶</a></dt>
