<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-package"></span><h1>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-drs-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AdditionalOptions</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">advanced_options</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">scalable_shares</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions"title="Permalink to this definition">¶</a></dt>
<li><p><strong>scalable_shares</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ScaleSharesBehavior</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable scalable shares for the resource pools on this cluster.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AffinityRule</span></code> class defines a set of virtual machines that DRS will
attempt to run on the same 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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not the rule is currently satisfied.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not the rule is enabled. Set this
property when user configures the rule. The default value is false
(disabled). If there is a rule conflict, the Server can override
the setting to disable a rule.
If None or empty, the value is skipped.</p></li>
<li><p><strong>in_compliance</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate if the rule is in compliance.
If None or empty, the value is skipped.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the rule.</p></li>
<li><p><strong>mandatory</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether compliance with this rule is mandatory or
optional. The default value is false (optional).
If None or empty, the value is skipped.</p></li>
<li><p><strong>user_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether the rule is created by the user or the
system.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vms</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of virtual machines.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Automation</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">automation_level</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">migration_threshold</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">proactive_drs_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">virtual_machine_automation</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Automation</span></code> class contains attributes describing the HA specific
configurations of a cluster. It contains cluster-wide configurations for
vSphereHA.</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>automation_level</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DrsBehaviorInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies the cluster-wide default DRS behavior for virtual
machines. You can override the default behavior for a virtual
machine.
If None or empty, the value is skipped.</p></li>
<li><p><strong>migration_threshold</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Threshold for generated recommendations. DRS generates only those
recommendations that are above the specified vmotionRate. Ratings
vary from 1 to 5.
If None or empty, the value is skipped.</p></li>
<li><p><strong>proactive_drs_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether or not the ProactiveDRS is enabled.
If None or empty, the value is skipped.</p></li>
<li><p><strong>virtual_machine_automation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag that dictates whether DRS Behavior overrides for individual
<p>The VMs in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">DependencyRule.vm_group</span></code> depends on the list of VMs
specified in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">DependencyRule.depends_on_vm_group</span></code>.</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not the rule is currently satisfied.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not the rule is enabled. Set this
property when user configures the rule. The default value is false
(disabled). If there is a rule conflict, the Server can override
the setting to disable a rule.
If None or empty, the value is skipped.</p></li>
<li><p><strong>in_compliance</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate if the rule is in compliance.
If None or empty, the value is skipped.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the rule.</p></li>
<li><p><strong>mandatory</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether compliance with this rule is mandatory or
optional. The default value is false (optional).
If None or empty, the value is skipped.</p></li>
<li><p><strong>user_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether the rule is created by the user or the
system.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vm_group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual group name. The virtual group may contain one or more
virtual machines.</p></li>
<li><p><strong>depends_on_vm_group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Depdendency virtual group name. The virtual group may contain one
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DpmBehaviorInfo</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DpmBehaviorInfo</span></code> class defines the automation level for DPM service
on a 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 <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DpmBehaviorInfo</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AUTOMATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DpmBehaviorInfo(string='AUTOMATED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo.AUTOMATED"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that VirtualCenter should generate recommendations for host power
operations, and should execute the recommendations automatically.</p>
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DpmBehaviorInfo(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that VirtualCenter should generate recommendations for host power
operations, but should not execute the recommendations automatically.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DrsBehaviorInfo</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DrsBehaviorInfo</span></code> class defines the automation levels that can be set
on a DRS 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 <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DrsBehaviorInfo</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FULLY_AUTOMATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DrsBehaviorInfo(string='FULLY_AUTOMATED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo.FULLY_AUTOMATED"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that VirtualCenter should automate both the migration of virtual
machines and their placement with a host at power on.</p>
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DrsBehaviorInfo(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that VirtualCenter should generate recommendations for virtual
machine migration and for placement with a host, but should not implement
<codeclass="sig-name descname"><spanclass="pre">PARTIALLY_AUTOMATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo.PARTIALLY_AUTOMATED"title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies that VirtualCenter should generate recommendations for virtual
machine migration and for placement with a host, but should automatically
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DrsConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">automation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">additional_options</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">power_management</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DrsConfig</span></code> class contains attributes describing the HA specific
configurations of a cluster. It contains cluster-wide configurations for
DAS.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether or not DRS service is enabled.
If None or empty, the value is skipped.</p></li>
<li><p><strong>automation</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Automation</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere HA configuration for Automation Level, Migration Threshold
Predictive DRS and VM Automation.</p></li>
<li><p><strong>additional_options</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AdditionalOptions</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere HA configuration for VM Distribution, CPU Over commit
Scalable Shares.</p></li>
<li><p><strong>power_management</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PowerManagement</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vSphere HA configuration for DPM, AutomationLevel, DPM Threshold.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DrsVmOverrides</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">behavior</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Group</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_groups</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_groups</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Group</span></code> class describes the properties of virtual machine and host
groups.</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>vm_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GroupDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of VM Group details.
If None or empty, the value is skipped.</p></li>
<li><p><strong>host_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GroupDetails</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of HOST Group details.
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">GroupDetails</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">entities</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">user_created</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Unique name of the group.</p></li>
<li><p><strong>entities</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of VMs or Hosts belonging to the group.
If None or empty, the value is skipped.</p></li>
<li><p><strong>user_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether the group is created by the user or the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">PowerManagement</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dpm_enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">automation_level</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dpm_threshold</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PowerManagement</span></code> class contains the fields describing DPM specific
configurations of a cluster.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>dpm_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether or not the service is enabled. This service
can not be enabled, unless DRS is enabled as well.
If None or empty, the value is skipped.</p></li>
<li><p><strong>automation_level</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DpmBehaviorInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Specifies the default VMware DPM behavior for hosts. This default
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ProactiveHAConfig</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">automation_level</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">remediation</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">providers</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ProactiveHAConfig</span></code> class defines the Configuration of the vSphere
InfraUpdateHA service on a cluster.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether or not the service is enabled.
InfraUpdateHA will not be active, unless DRS is enabled as well.
If None or empty, the value is skipped.</p></li>
<li><p><strong>automation_level</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ProactiveHAConfig.BehaviorType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configured behavior. Values are of type
InfraUpdateHaConfig.BehaviorType.
If None or empty, the value is skipped.</p></li>
<li><p><strong>remediation</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ProactiveHAConfig.RemediationType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configured remediation for moderately degraded hosts. Values are of
type InfraUpdateHaConfig.RemediationType.
If None or empty, the value is skipped.</p></li>
<li><p><strong>providers</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The list of health update providers configured for this cluster.
Providers are identified by their id. If the provider list is
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">BehaviorType</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ProactiveHAConfig.BehaviorType</span></code> class defines the behavior for
executing the proposed DRS recommendations.</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">BehaviorType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AUTOMATED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BehaviorType(string='AUTOMATED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType.AUTOMATED"title="Permalink to this definition">¶</a></dt>
<dd><p>With this behavior configured, the proposed DRS recommendations are
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">BehaviorType(string='MANUAL')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType.MANUAL"title="Permalink to this definition">¶</a></dt>
<dd><p>With this behavior configured, the proposed DRS recommendations require
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RemediationType</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ProactiveHAConfig.RemediationType</span></code> class defines the types of
remediation behaviours that can be configured.</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">RemediationType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">MAINTENANCE_MODE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RemediationType(string='MAINTENANCE_MODE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType.MAINTENANCE_MODE"title="Permalink to this definition">¶</a></dt>
<dd><p>With this behavior configured, a degraded host will be recommended to be
<codeclass="sig-name descname"><spanclass="pre">QUARANTINE_MODE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RemediationType(string='QUARANTINE_MODE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType.QUARANTINE_MODE"title="Permalink to this definition">¶</a></dt>
<dd><p>With this behavior configured, a degraded host will be recommended to be
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Rule</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vm_affinity_rules</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm_anti_affinity_rules</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dependency_rule</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">vm_host_rule</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Rule</span></code> class describes affinity and anti-affinity DRS rules that
affect the placement of virtual machines in a cluster.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vm_affinity_rules</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AffinityRule</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster-wide VM affinity rules.If this is set then
<li><p><strong>vm_anti_affinity_rules</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AffinityRule</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster-wide VM anti affinity rules.If this is set then
<li><p><strong>dependency_rule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DependencyRule"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DependencyRule"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DependencyRule</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster-wide VM-to-VM dependency rules.If this is set then
<li><p><strong>vm_host_rule</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.VmHostRule"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.VmHostRule"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VmHostRule</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster-wide VM-to-Host affinity rules.If this is set then
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ScaleSharesBehavior</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior"title="Permalink to this definition">¶</a></dt>
<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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ScaleSharesBehavior</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ScaleSharesBehavior(string='DISABLED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior.DISABLED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SCALE_CPU_AND_MEMORY_SHARES</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ScaleSharesBehavior(string='SCALE_CPU_AND_MEMORY_SHARES')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior.SCALE_CPU_AND_MEMORY_SHARES"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"title="Permalink to this definition">¶</a></dt>
<p>The Status enumeration defines a general “health” value for a managed
entity.</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">GRAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='GRAY')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.GRAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">GREEN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='GREEN')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.GREEN"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">RED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.RED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">YELLOW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='YELLOW')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.YELLOW"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">VmHostRule</span></code> class defines virtual machines and host groups that
determine virtual machine placement. The virtual machines and hosts
referenced by a VM-Host rule must be in the same cluster.</p>
<blockquote>
<div><p>A VM-Host rule identifies the following groups.</p>
</div></blockquote>
<ulclass="simple">
<li><p>A virtual machine group (vim.cluster.VmGroup).</p></li>
<li><p>Two host groups - an affine host group and an anti-affine host group
(vim.cluster.HostGroup). At least one of the groups must contain one or
more hosts.</p></li>
</ul>
<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.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not the rule is currently satisfied.</p></li>
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether or not the rule is enabled. Set this
property when user configures the rule. The default value is false
(disabled). If there is a rule conflict, the Server can override
the setting to disable a rule.
If None or empty, the value is skipped.</p></li>
<li><p><strong>in_compliance</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate if the rule is in compliance.
If None or empty, the value is skipped.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the rule.</p></li>
<li><p><strong>mandatory</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether compliance with this rule is mandatory or
optional. The default value is false (optional).
If None or empty, the value is skipped.</p></li>
<li><p><strong>user_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag to indicate whether the rule is created by the user or the
system.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vm_group_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual group name.
If None or empty, the value is skipped.</p></li>
<li><p><strong>affine_host_group_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the affine host group. The affine host group identifies
hosts on which VmHotRule#vmGroupName virtual machines can be
powered-on.
If None or empty, the value is skipped.</p></li>
<li><p><strong>anti_affine_host_group_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the anti-affine host group. The anti-affine host group
identifies hosts on which VmHotRule#vmGroupName virtual machines
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-ha-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">FailuresAndResponses</span></code> class contains attributes describing the
Failures and responses specific configurations of a cluster. It contains
cluster-wide configurations for vsphere HA.</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_failures_cluster_tolerates</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of host failures that should be tolerated, still
guaranteeing sufficient resources to restart virtual machines on
available hosts. If not set, we assume 1.</p></li>
<li><p><strong>dedicated_failover_hosts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of hosts dedicated for failover.</p></li>
<li><p><strong>performance_degradation_vm_tolerate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Percentage of resource reduction that a cluster of VMs can tolerate
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">ClusterResourcePercentage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cpu</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>default_vm_restart_priority</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.RestartPriority</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Restart priority for a virtual machine.</p>
<p>If not specified at either the cluster level or the virtual machine
level, this will default to <codeclass="docutils literal notranslate"><spanclass="pre">medium</span></code>.
If None or empty, the value is skipped.</p>
</p></li>
<li><p><strong>restart_priority_condition_timeout</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This setting is used to specify a maximum time the lower priority
VMs should wait for the higher priority VMs to be ready. If the
higher priority Vms are not ready by this time, then the lower
priority VMs are restarted irrespective of the VM ready state. This
timeout can be used to prevent the failover of lower priority VMs
to be stuck infinitely. Timeout specified in seconds. To use
cluster setting for a VM override, set to -1 in per-VM. setting.
If None or empty, the value is skipped.</p></li>
<li><p><strong>additional_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – After condition has been met, a mandatory delay before starting the
next VM restart priority.</p></li>
<li><p><strong>host_isolation_response</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.IsolationResponse</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Indicates whether or not the virtual machine should be powered off
if a host determines that it is isolated from the rest of the
compute resource.</p>
<p>If not specified at either the cluster level or the virtual machine
level, this will default to <codeclass="docutils literal notranslate"><spanclass="pre">powerOff</span></code>.
If None or empty, the value is skipped.</p>
</p></li>
<li><p><strong>datastore_with_pdl_failure_response</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.StorageVmReaction</span></code></a>) – VM storage protection setting for storage failures categorized as
Permenant Device Loss (PDL). PDL indicates storage device failure
or LUN removal. In case of PDL, the failed datastore or device is
unlikely to recover. The details of PDL are</p></li>
<li><p><strong>apd_failure_response</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.StorageVmReaction</span></code></a>) – VM storage protection setting for storage failures categorized as
All Paths Down (APD). APD is a condition where a storage has become
inaccessible for unknown reasons. It only indicates loss of
connectivity and does not indicate storage device failure or LUN
removal (Permanent Device Loss or PDL)</p></li>
<li><p><strong>response_recovery</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.VmReactionOnAPDCleared</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Action taken by VM Component Protection service for a powered on VM
when APD condition clears after APD timeout.</p>
<p>This property is meaningful only when vSphere HA is turned on.
Valid values are specified by
<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.VmReactionOnAPDCleared</span></code></a>. The default
value is VmReactionOnAPDCleared#none for cluster setting and
VmReactionOnAPDCleared#useClusterDefault for per-VM setting.</p>
</p></li>
<li><p><strong>response_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time interval after an APD timeout has been declared and before
VM Component Protection service will terminate the VM. The default
value is 180 seconds if not specified. To use cluster setting for a
VM override, set to -1 in per-VM setting.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">IsolationResponse</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse"title="Permalink to this definition">¶</a></dt>
<p>The enum defines values that indicate whether or not the virtual machine
should be powered off if a host determines that it is isolated from the
rest of 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">IsolationResponse</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_ISOLATION_RESPONSE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IsolationResponse(string='CLUSTER_ISOLATION_RESPONSE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.CLUSTER_ISOLATION_RESPONSE"title="Permalink to this definition">¶</a></dt>
<dd><p>Use the default isolation response defined for the cluster that contains
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IsolationResponse(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>Do not power off the virtual machine in the event of a host network
<codeclass="sig-name descname"><spanclass="pre">POWER_OFF</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IsolationResponse(string='POWER_OFF')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.POWER_OFF"title="Permalink to this definition">¶</a></dt>
<dd><p>Power off the virtual machine in the event of a host network isolation.</p>
<codeclass="sig-name descname"><spanclass="pre">SHUTDOWN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">IsolationResponse(string='SHUTDOWN')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.SHUTDOWN"title="Permalink to this definition">¶</a></dt>
<dd><p>Shut down the virtual machine guest operating system in the event of a host
network isolation. If the guest operating system fails to shutdown within
five minutes, HA will initiate a forced power off.</p>
<p>When you use the shutdown isolation response, failover can take longer
(compared to the response) because the virtual machine cannot fail over
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RestartPriority</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority"title="Permalink to this definition">¶</a></dt>
<p>The enum defines virtual machine restart priority values to resolve
resource contention. The priority determines the preference that HA gives
to a virtual machine if sufficient capacity is not available to power on
all failed virtual machines. For example, high priority virtual machines on
a host get preference over low priority virtual machines.</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">RestartPriority</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_RESTART_PRIORITY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='CLUSTER_RESTART_PRIORITY')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.CLUSTER_RESTART_PRIORITY"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machines with this priority use the default restart priority
defined for the cluster that contains this virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='DISABLED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>vSphere HA is disabled for this virtual machine.</p>
<codeclass="sig-name descname"><spanclass="pre">HIGH</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='HIGH')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.HIGH"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machines with this priority have a higher chance of powering on
after a failure if there is insufficient capacity on hosts to meet all
<codeclass="sig-name descname"><spanclass="pre">HIGHEST</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='HIGHEST')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.HIGHEST"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machines with this priority have the highest chance of powering on
after a failure if there is insufficient capacity on hosts to meet all
<codeclass="sig-name descname"><spanclass="pre">LOW</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='LOW')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.LOW"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machines with this priority have a lower chance of powering on
after a failure if there is insufficient capacity on hosts to meet all
<codeclass="sig-name descname"><spanclass="pre">LOWEST</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='LOWEST')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.LOWEST"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machines with this priority have the lowest chance of powering on
after a failure if there is insufficient capacity on hosts to meet all
<codeclass="sig-name descname"><spanclass="pre">MEDIUM</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">RestartPriority(string='MEDIUM')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.MEDIUM"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machines with this priority have an intermediate chance of powering
on after a failure if there is insufficient capacity on hosts to meet all
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ServiceState</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState"title="Permalink to this definition">¶</a></dt>
<p>Possible states of an HA service. All services support the disabled and
enabled states.</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">ServiceState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ServiceState(string='DISABLED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState.DISABLED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ENABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ServiceState(string='ENABLED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState.ENABLED"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StorageVmReaction</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"title="Permalink to this definition">¶</a></dt>
<p>The VM policy settings that determine the response to storage failures.</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">StorageVmReaction</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLUSTER_DEFAULT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageVmReaction(string='CLUSTER_DEFAULT')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.CLUSTER_DEFAULT"title="Permalink to this definition">¶</a></dt>
<dd><p>VM will use the cluster default setting. This option is only meaningful for
<codeclass="sig-name descname"><spanclass="pre">DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageVmReaction(string='DISABLED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>VM Component Protection service will not monitor or react to the component
failure. This setting does not affect other vSphere HA services such as
<codeclass="sig-name descname"><spanclass="pre">RESTART_AGGRESSIVE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageVmReaction(string='RESTART_AGGRESSIVE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.RESTART_AGGRESSIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>VM Component Protection service protects VMs aggressively. With this
setting, the service will terminate an affected VM even if it can’t
determine that capacity exists to restart the VM.</p>
<codeclass="sig-name descname"><spanclass="pre">RESTART_CONSERVATIVE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageVmReaction(string='RESTART_CONSERVATIVE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.RESTART_CONSERVATIVE"title="Permalink to this definition">¶</a></dt>
<dd><p>VM Component Protection service protects VMs conservatively. With this
setting, when the service can’t determine that capacity is available to
restart a VM, it will favor keeping the VM running.</p>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">StorageVmReaction(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>VM Component Protection service will monitor component failures but will
not restart an affected VM. Rather it will notify users about the component
failures. This setting does not affect other vSphere HA services such as
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmMonitoringState</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState"title="Permalink to this definition">¶</a></dt>
<p>The enum defines values that indicate the state of Virtual Machine Health
Monitoring. Health Monitoring uses the vmTools (guest) and application
agent heartbeat modules. You can configure HA to respond to heartbeat
failures of either one or both modules. You can also disable the HA
response to heartbeat failures.</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">VmMonitoringState</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">VM_AND_APP_MONITORING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VmMonitoringState(string='VM_AND_APP_MONITORING')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState.VM_AND_APP_MONITORING"title="Permalink to this definition">¶</a></dt>
<dd><p>HA response to both guest and application heartbeat failure is enabled.</p>
<codeclass="sig-name descname"><spanclass="pre">VM_MONITORING_DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VmMonitoringState(string='VM_MONITORING_DISABLED')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState.VM_MONITORING_DISABLED"title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual machine health monitoring is disabled. In this state, HA response
to guest and application heartbeat failures are disabled.</p>
<codeclass="sig-name descname"><spanclass="pre">VM_MONITORING_ONLY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VmMonitoringState(string='VM_MONITORING_ONLY')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState.VM_MONITORING_ONLY"title="Permalink to this definition">¶</a></dt>
<dd><p>HA response to guest heartbeat failure is enabled.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">VmReactionOnAPDCleared</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"title="Permalink to this definition">¶</a></dt>
<p>If an APD condition clears after an APD timeout condition has been declared
and before VM Component Protection service terminated the VM, the guestOS
and application may no longer be operational.</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">VmReactionOnAPDCleared</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VmReactionOnAPDCleared(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared.NONE"title="Permalink to this definition">¶</a></dt>
<dd><p>VM Component Protection service will not react after APD condition is
<codeclass="sig-name descname"><spanclass="pre">RESET</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VmReactionOnAPDCleared(string='RESET')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared.RESET"title="Permalink to this definition">¶</a></dt>
<dd><p>VM Component Protection service will reset the VM after APD condition is
cleared. Note this only applies if the subject VM is still powered on.</p>
<codeclass="sig-name descname"><spanclass="pre">USE_CLUSTER_DEFAULT</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">VmReactionOnAPDCleared(string='USE_CLUSTER_DEFAULT')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared.USE_CLUSTER_DEFAULT"title="Permalink to this definition">¶</a></dt>
<dd><p>VM will use the cluster default setting. This option is only meaningful for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">FixedSizeSlotPolicy</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cpu</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">memory</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy"title="Permalink to this definition">¶</a></dt>
<p>This policy allows setting a fixed slot size</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>cpu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The cpu component of the slot size (in MHz)</p></li>
<li><p><strong>memory</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The memory component of the slot size (in megabytes)</p></li>
<p>The VmOverrides data object contains the HA configuration settings for vm
as a override from cluster. All fields are optional.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Reference to the virtual machine.</p></li>
<li><p><strong>vm_restart_priority</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.RestartPriority</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Restart priority for a virtual machine.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vm_additional_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – After condition has been met, a mandatory delay before starting the
next VM restart priority.</p></li>
<li><p><strong>vm_restart_priority_timeout</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – This setting is used to specify a maximum time the lower priority
VMs should wait for the higher priority VMs to be ready. If the
higher priority Vms are not ready by this time, then the lower
priority VMs are restarted irrespective of the VM ready state. This
timeout can be used to prevent the failover of lower priority VMs
to be stuck infinitely.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vm_isolation_response</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.IsolationResponse</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Indicates whether or not the virtual machine should be powered off
if a host determines that it is isolated from the rest of the
compute resource.</p>
<p>If not specified at either the cluster level or the virtual machine
level, this will default to <codeclass="docutils literal notranslate"><spanclass="pre">powerOff</span></code>.
If None or empty, the value is skipped.</p>
</p></li>
<li><p><strong>vm_datastore_with_pdl_failure_response</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.StorageVmReaction</span></code></a>) – VM storage protection setting for storage failures categorized as
Permenant Device Loss (PDL). PDL indicates storage device failure
or LUN removal. In case of PDL, the failed datastore or device is
unlikely to recover. The details of PDL are</p></li>
<li><p><strong>vm_apd_failure_response</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.StorageVmReaction</span></code></a>) – VM storage protection setting for storage failures categorized as
All Paths Down (APD). APD is a condition where a storage has become
inaccessible for unknown reasons. It only indicates loss of
connectivity and does not indicate storage device failure or LUN
removal (Permanent Device Loss or PDL)</p></li>
<li><p><strong>vm_apd_failover_delay</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The time interval after an APD timeout has been declared and before
VM Component Protection service will terminate the VM. The default
value is 180 seconds if not specified. To use cluster setting for a
VM override, set to -1 in per-VM setting.</p></li>
<li><p><strong>vm_apd_response_recovery</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.VmReactionOnAPDCleared</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Action taken by VM Component Protection service for a powered on VM
when APD condition clears after APD timeout. This property is
meaningful only when vSphere HA is turned on. Valid values are</p></li>
<li><p><strong>vm_monitoring</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses.VmMonitoringState</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Virtual machine health monitoring is disabled. In this state, HA
response to guest and application heartbeat failures are disabled.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HeartBeatDataStores</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">heartbeat_datastore_policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">datastores</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">HBDatastoreCandidate</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate"title="Permalink to this definition">¶</a></dt>
<p>The policy to determine the candidates from which vCenter Server can choose
heartbeat datastores.</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">HBDatastoreCandidate</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ALL_FEASIBLE_DS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HBDatastoreCandidate(string='ALL_FEASIBLE_DS')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate.ALL_FEASIBLE_DS"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server chooses heartbeat datastores from all the feasible ones,
i.e., the datastores that are accessible to more than one host in the
cluster. The choice will be made without giving preference to those
specified by the user (see #heartbeatDatastore).</p>
<codeclass="sig-name descname"><spanclass="pre">ALL_FEASIBLE_DS_WITH_USER_PREFERENCE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HBDatastoreCandidate(string='ALL_FEASIBLE_DS_WITH_USER_PREFERENCE')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate.ALL_FEASIBLE_DS_WITH_USER_PREFERENCE"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server chooses heartbeat datastores from all the feasible ones
while giving preference to those specified by the user (see
#heartbeatDatastore). More specifically, the datastores not included in
#heartbeatDatastore will be chosen if and only if the specified ones are
<codeclass="sig-name descname"><spanclass="pre">USER_SELECTED_DS</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">HBDatastoreCandidate(string='USER_SELECTED_DS')</span></em><aclass="headerlink"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate.USER_SELECTED_DS"title="Permalink to this definition">¶</a></dt>
<dd><p>vCenter Server chooses heartbeat datastores from the set specified by the
user (see #heartbeatDatastore). More specifically, datastores not included
in the set will not be chosen. Note that if #heartbeatDatastore is empty,
datastore heartbeating will be disabled for HA.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<p>The vim.cluster.VmToolsMonitoringSettings data object contains virtual
machine monitoring settings that are used by the Virtual Machine Health
Monitoring Service. The Service checks the VMware Tools heartbeat of a
virtual machine. If heartbeats have not been received within a specified
time interval, the Service declares the virtual machine as failed and
resets the virtual machine. All fields are optional. In case of a
reconfiguration, fields left unset are not changed.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether or not the Virtual Machine Health
Monitoring service is enabled.</p>
<blockquote>
<div><p>The Server does not use this property.</p>
</div></blockquote>
</p></li>
<li><p><strong>cluster_settings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Flag indicating whether to use the cluster settings or the per VM
settings.</p>
<blockquote>
<div><p>The default value is true.</p>
</div></blockquote>
</p></li>
<li><p><strong>failure_interval</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>If no heartbeat has been received for at least the specified number
of seconds, the virtual machine is declared as failed.</p>
<blockquote>
<div><p>The default value is 30.</p>
</div></blockquote>
</p></li>
<li><p><strong>min_up_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>The number of seconds for the virtual machine’s heartbeats to
stabilize after the virtual machine has been powered on. This time
should include the guest operating system boot-up time. The virtual
machine monitoring will begin only after this period.</p>
<blockquote>
<div><p>The default value is 120.</p>
</div></blockquote>
</p></li>
<li><p><strong>max_failures</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>Maximum number of failures and automated resets allowed during the
time that <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VmToolsMonitoringSettings.max_failure_window</span></code>
specifies. If <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VmToolsMonitoringSettings.max_failure_window</span></code>
is -1 (no window), this represents the absolute number of failures
after which automated response is stopped.</p>
<p>If a virtual machine exceeds this threshold, in-depth problem
analysis is usually needed.</p>
<blockquote>
<div><p>The default value is 3.</p>
</div></blockquote>
</p></li>
<li><p><strong>max_failure_window</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>The number of seconds for the window during which up to
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">VmToolsMonitoringSettings.max_failures</span></code> resets can occur
before automated responses stop.</p>
<blockquote>
<div><p>If set to -1, no failure window is specified.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><codeclass="sig-name descname"><spanclass="pre">VsphereHA</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">failures_and_responses</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">admission_control</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">heartbeat_datastores</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">advanced_options</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DasInfo</span></code> class contains attributes describing the HA specific
configurations of a cluster. It contains cluster-wide configurations for
DAS.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – HA Enabled or Disabled Flag to indicate whether or not vSphere HA
feature is enabled.</p></li>
<li><p><strong>failures_and_responses</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FailuresAndResponses</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration settings for HA Failures and responses.
If None or empty, the value is skipped.</p></li>
<li><p><strong>admission_control</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.AdmissionControl"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.AdmissionControl"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AdmissionControl</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration settings for HA admission control.
If None or empty, the value is skipped.</p></li>
<li><p><strong>heartbeat_datastores</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HeartBeatDataStores</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configuration settings for heart beat data store policy.
<spanid="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-vsan-client-module"></span><h2>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client module<aclass="headerlink"href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.</span></code><codeclass="sig-name descname"><spanclass="pre">HostDefaultInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">checksum_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.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo"title="Permalink to this definition">¶</a></dt>
<p>Default VSAN service configuration to be used for hosts admitted to 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"><p><strong>checksum_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Whether the VSAN service is configured to enforce checksum
protection. If omitted while enabling the VSAN service, this value
will default to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code>. Change this value to <codeclass="docutils literal notranslate"><spanclass="pre">false</span></code> shall not
affect any existing disk status. Changing this value to <codeclass="docutils literal notranslate"><spanclass="pre">true</span></code>
shall do disk enforcement check that all VSAN disks are checksum
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_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.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.</span></code><codeclass="sig-name descname"><spanclass="pre">VsanConfigInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">enabled</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_config</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.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo"title="Permalink to this definition">¶</a></dt>
<p>The <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">VsanConfigInfo</span></code></a> data object contains configuration data for the
VSAN service in a cluster. This data object is used both for specifying
cluster-wide settings when updating the VSAN service, and as an output
datatype when retrieving current cluster-wide VSAN service settings.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Whether the VSAN service is enabled for the cluster.</p></li>
<li><p><strong>default_config</strong> (<aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostDefaultInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Default VSAN settings to use for hosts admitted to the cluster when
the VSAN service is enabled. If omitted, values will default as
though the fields in the <aclass="reference internal"href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo"title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostDefaultInfo</span></code></a> have been
