Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
621aa7b28d
vsphere-automation-sdk-python/vsphere/7.0.3.0/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.html
Shweta 4b77198d0f
703 api reference docs (#289) 
Signed-off-by: shweta <spurohit@vmware.com>
2021-10-13 19:14:42 +05:30

1653 lines
172 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package &mdash; vSphere Automation SDK for Python. 7.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.cis package" href="com.vmware.cis.html" />
<link rel="prev" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory package" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
</a>
<div class="version">
7.0.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.appliance.html">com.vmware.appliance package</a> &raquo;</li>
<li><a href="com.vmware.appliance.vcenter.html">com.vmware.appliance.vcenter package</a> &raquo;</li>
<li><a href="com.vmware.appliance.vcenter.settings.html">com.vmware.appliance.vcenter.settings package</a> &raquo;</li>
<li><a href="com.vmware.appliance.vcenter.settings.v1.html">com.vmware.appliance.vcenter.settings.v1 package</a> &raquo;</li>
<li><a href="com.vmware.appliance.vcenter.settings.v1.config.html">com.vmware.appliance.vcenter.settings.v1.config package</a> &raquo;</li>
<li><a href="com.vmware.appliance.vcenter.settings.v1.config.components.html">com.vmware.appliance.vcenter.settings.v1.config.components package</a> &raquo;</li>
<li><a href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html">com.vmware.appliance.vcenter.settings.v1.config.components.inventory package</a> &raquo;</li>
<li>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster">
<span id="com-vmware-appliance-vcenter-settings-v1-config-components-inventory-cluster-package"></span><h1>com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster package<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client">
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client" title="Permalink to this headline"></a></h2>
<p>The
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client</span></code>
module provides classes to manage the vCenter Server Inventory Cluster DRS
settings.</p>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">AdditionalOptions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">advanced_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scalable_shares</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AdditionalOptions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AdditionalOptions</span></code> class contains attributes describing the HA
specific configurations of a cluster. It contains cluster-wide
configurations for vSphereHA.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>advanced_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Drs configuration additional options</p></li>
<li><p><strong>scalable_shares</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScaleSharesBehavior</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable scalable shares for the resource pools on this cluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">AffinityRule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_compliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mandatory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.AffinityRule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AffinityRule</span></code> class defines a set of virtual machines that DRS will
attempt to run on the same host.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether or not the rule is currently satisfied.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the rule.</p></li>
<li><p><strong>mandatory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of virtual machines.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">Automation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">automation_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">migration_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proactive_drs_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">virtual_machine_automation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Automation" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Automation</span></code> class contains attributes describing the HA specific
configurations of a cluster. It contains cluster-wide configurations for
vSphereHA.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>automation_level</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DrsBehaviorInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag that dictates whether DRS Behavior overrides for individual
VMs.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DependencyRule">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">DependencyRule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_compliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mandatory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depends_on_vm_group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DependencyRule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DependencyRule</span></code> class defines VM-to-VM dependencies.</p>
<blockquote>
<div><p>A VM-VM Dependency rule identifies the following groups.</p>
</div></blockquote>
<ul class="simple">
<li><p>A virtual machine group - <code class="xref py py-attr docutils literal notranslate"><span class="pre">DependencyRule.vm_group</span></code></p></li>
<li><p>A “depends on” virtual machine group -
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DependencyRule.depends_on_vm_group</span></code>.</p></li>
</ul>
<p>The VMs in <code class="xref py py-attr docutils literal notranslate"><span class="pre">DependencyRule.vm_group</span></code> depends on the list of VMs
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">DependencyRule.depends_on_vm_group</span></code>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether or not the rule is currently satisfied.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the rule.</p></li>
<li><p><strong>mandatory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual group name. The virtual group may contain one or more
virtual machines.</p></li>
<li><p><strong>depends_on_vm_group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Depdendency virtual group name. The virtual group may contain one
or more virtual machines.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">DpmBehaviorInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DpmBehaviorInfo</span></code> class defines the automation level for DPM service
on a cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DpmBehaviorInfo</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo.AUTOMATED">
<code class="sig-name descname"><span class="pre">AUTOMATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DpmBehaviorInfo(string='AUTOMATED')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DpmBehaviorInfo.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DpmBehaviorInfo(string='MANUAL')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">DrsBehaviorInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DrsBehaviorInfo</span></code> class defines the automation levels that can be set
on a DRS cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DrsBehaviorInfo</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo.FULLY_AUTOMATED">
<code class="sig-name descname"><span class="pre">FULLY_AUTOMATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DrsBehaviorInfo(string='FULLY_AUTOMATED')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DrsBehaviorInfo(string='MANUAL')</span></em><a class="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
the recommendations automatically.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsBehaviorInfo.PARTIALLY_AUTOMATED">
<code class="sig-name descname"><span class="pre">PARTIALLY_AUTOMATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')</span></em><a class="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
implement only the placement at power on.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">DrsConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">power_management</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DrsConfig</span></code> class contains attributes describing the HA specific
configurations of a cluster. It contains cluster-wide configurations for
DAS.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Automation</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdditionalOptions</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – vSphere HA configuration for VM Distribution, CPU Over commit
Scalable Shares.</p></li>
<li><p><strong>power_management</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">PowerManagement</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – vSphere HA configuration for DPM, AutomationLevel, DPM Threshold.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">DrsVmOverrides</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">behavior</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.DrsVmOverrides" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DrsVmOverrides</span></code> class contains the fields describing DRS behavior
override for individual virtual machines in the cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Reference to the virtual machine.</p></li>
<li><p><strong>behavior</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DrsBehaviorInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the particular DRS behavior for this virtual machine.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">Group</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Group" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Group</span></code> class describes the properties of virtual machine and host
groups.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm_groups</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupDetails</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">GroupDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of HOST Group details.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">GroupDetails</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.GroupDetails" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique name of the group.</p></li>
<li><p><strong>entities</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether the group is created by the user or the
system.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">PowerManagement</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dpm_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automation_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dpm_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.PowerManagement" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PowerManagement</span></code> class contains the fields describing DPM specific
configurations of a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dpm_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DpmBehaviorInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies the default VMware DPM behavior for hosts. This default
behavior can be overridden on a per host.
If None or empty, the value is skipped.</p></li>
<li><p><strong>dpm_threshold</strong> (<a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – DPM Advanced options.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">ProactiveHAConfig</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">automation_level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remediation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">providers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ProactiveHAConfig</span></code> class defines the Configuration of the vSphere
InfraUpdateHA service on a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProactiveHAConfig.BehaviorType</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProactiveHAConfig.RemediationType</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The list of health update providers configured for this cluster.
Providers are identified by their id. If the provider list is
empty, InfraUpdateHA will not be active.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">BehaviorType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ProactiveHAConfig.BehaviorType</span></code> class defines the behavior for
executing the proposed DRS recommendations.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BehaviorType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType.AUTOMATED">
<code class="sig-name descname"><span class="pre">AUTOMATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">BehaviorType(string='AUTOMATED')</span></em><a class="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
executed immediately.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.BehaviorType.MANUAL">
<code class="sig-name descname"><span class="pre">MANUAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">BehaviorType(string='MANUAL')</span></em><a class="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
manual approval before they are executed.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RemediationType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ProactiveHAConfig.RemediationType</span></code> class defines the types of
remediation behaviours that can be configured.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">RemediationType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType.MAINTENANCE_MODE">
<code class="sig-name descname"><span class="pre">MAINTENANCE_MODE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RemediationType(string='MAINTENANCE_MODE')</span></em><a class="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
placed in Maintenance Mode.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ProactiveHAConfig.RemediationType.QUARANTINE_MODE">
<code class="sig-name descname"><span class="pre">QUARANTINE_MODE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RemediationType(string='QUARANTINE_MODE')</span></em><a class="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
placed in Quarantine Mode.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">Rule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vm_affinity_rules</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_anti_affinity_rules</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dependency_rule</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_host_rule</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Rule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Rule</span></code> class describes affinity and anti-affinity DRS rules that
affect the placement of virtual machines in a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vm_affinity_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">AffinityRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide VM affinity rules.If this is set then
AntiAffinityRule, <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DependencyRule</span></code></a>, <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmHostRule</span></code></a> can
not be set.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vm_anti_affinity_rules</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">AffinityRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide VM anti affinity rules.If this is set then
AntiAffinityRule, <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DependencyRule</span></code></a>, <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmHostRule</span></code></a> can
not be set.
If None or empty, the value is skipped.</p></li>
<li><p><strong>dependency_rule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DependencyRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide VM-to-VM dependency rules.If this is set then
<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">AffinityRule</span></code></a>, AntiAffinityRule, <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmHostRule</span></code></a> can
not be set.
If None or empty, the value is skipped.</p></li>
<li><p><strong>vm_host_rule</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmHostRule</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Cluster-wide VM-to-Host affinity rules.If this is set then
<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">AffinityRule</span></code></a>, AntiAffinityRule, <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">DependencyRule</span></code></a>
can not be set.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">ScaleSharesBehavior</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScaleSharesBehavior</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior.DISABLED">
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ScaleSharesBehavior(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>Do not scale shares</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.ScaleSharesBehavior.SCALE_CPU_AND_MEMORY_SHARES">
<code class="sig-name descname"><span class="pre">SCALE_CPU_AND_MEMORY_SHARES</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ScaleSharesBehavior(string='SCALE_CPU_AND_MEMORY_SHARES')</span></em><a class="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>
<dd><p>Scale both CPU and memory shares</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The Status enumeration defines a general “health” value for a managed
entity.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.GRAY">
<code class="sig-name descname"><span class="pre">GRAY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='GRAY')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.GRAY" title="Permalink to this definition"></a></dt>
<dd><p>The status is unknown.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.GREEN">
<code class="sig-name descname"><span class="pre">GREEN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='GREEN')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.GREEN" title="Permalink to this definition"></a></dt>
<dd><p>The entity is OK.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.RED">
<code class="sig-name descname"><span class="pre">RED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='RED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.RED" title="Permalink to this definition"></a></dt>
<dd><p>The entity definitely has a problem.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.YELLOW">
<code class="sig-name descname"><span class="pre">YELLOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Status(string='YELLOW')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.Status.YELLOW" title="Permalink to this definition"></a></dt>
<dd><p>The entity might have a problem.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.VmHostRule">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.</span></code><code class="sig-name descname"><span class="pre">VmHostRule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_compliance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mandatory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_created</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_group_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">affine_host_group_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">anti_affine_host_group_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.drs_client.VmHostRule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="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>
<ul class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Flag to indicate whether or not the rule is currently satisfied.</p></li>
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the rule.</p></li>
<li><p><strong>mandatory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Virtual group name.
If None or empty, the value is skipped.</p></li>
<li><p><strong>affine_host_group_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – 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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Name of the anti-affine host group. The anti-affine host group
identifies hosts on which VmHotRule#vmGroupName virtual machines
should not be powered-on.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client">
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client" title="Permalink to this headline"></a></h2>
<p>The
<code class="docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client</span></code>
module provides classes to manage the vCenter Server Inventory Cluster HA
settings.</p>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.AdmissionControl">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">AdmissionControl</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_failures_cluster_tolerates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">policy_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_fail_over_slot_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_resource_percentage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dedicated_failover_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">performance_degradation_vm_tolerate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.AdmissionControl" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host_failures_cluster_tolerates</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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>policy_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>host_fail_over_slot_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">FixedSizeSlotPolicy</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This policy allows setting a fixed slot size</p></li>
<li><p><strong>cluster_resource_percentage</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterResourcePercentage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>dedicated_failover_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of hosts dedicated for failover.</p></li>
<li><p><strong>performance_degradation_vm_tolerate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Percentage of resource reduction that a cluster of VMs can tolerate
in case of a failover.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">ClusterResourcePercentage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.ClusterResourcePercentage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>This class defines CPU, Memory resource percentages.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cpu</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Reserved failover CPU capacity</p></li>
<li><p><strong>memory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Reserved failover Memory capacity</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">FailuresAndResponses</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_monitoring</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_vm_restart_priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restart_priority_condition_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">additional_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_isolation_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastore_with_pdl_failure_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apd_failure_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_recovery</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_monitoring</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_tools_monitoring_settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host_monitoring</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.ServiceState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>default_vm_restart_priority</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.RestartPriority</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">medium</span></code>.
If None or empty, the value is skipped.</p>
</p></li>
<li><p><strong>restart_priority_condition_timeout</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.IsolationResponse</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">powerOff</span></code>.
If None or empty, the value is skipped.</p>
</p></li>
<li><p><strong>datastore_with_pdl_failure_response</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.VmReactionOnAPDCleared</span></code></a> or <code class="docutils literal notranslate"><span class="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
<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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_monitoring</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.VmMonitoringState</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>vm_tools_monitoring_settings</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VmToolsMonitoringSettings" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VmToolsMonitoringSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">VmToolsMonitoringSettings</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">IsolationResponse</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">IsolationResponse</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.CLUSTER_ISOLATION_RESPONSE">
<code class="sig-name descname"><span class="pre">CLUSTER_ISOLATION_RESPONSE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IsolationResponse(string='CLUSTER_ISOLATION_RESPONSE')</span></em><a class="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
this virtual machine.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IsolationResponse(string='NONE')</span></em><a class="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
isolation.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.POWER_OFF">
<code class="sig-name descname"><span class="pre">POWER_OFF</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IsolationResponse(string='POWER_OFF')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.IsolationResponse.SHUTDOWN">
<code class="sig-name descname"><span class="pre">SHUTDOWN</span></code><em class="property"> <span class="pre">=</span> <span class="pre">IsolationResponse(string='SHUTDOWN')</span></em><a class="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
until it is shutdown.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">RestartPriority</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">RestartPriority</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.CLUSTER_RESTART_PRIORITY">
<code class="sig-name descname"><span class="pre">CLUSTER_RESTART_PRIORITY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='CLUSTER_RESTART_PRIORITY')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.DISABLED">
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='DISABLED')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.HIGH">
<code class="sig-name descname"><span class="pre">HIGH</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='HIGH')</span></em><a class="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
virtual machine needs.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.HIGHEST">
<code class="sig-name descname"><span class="pre">HIGHEST</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='HIGHEST')</span></em><a class="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
virtual machine needs.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.LOW">
<code class="sig-name descname"><span class="pre">LOW</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='LOW')</span></em><a class="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
virtual machine needs.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.LOWEST">
<code class="sig-name descname"><span class="pre">LOWEST</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='LOWEST')</span></em><a class="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
virtual machine needs.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.RestartPriority.MEDIUM">
<code class="sig-name descname"><span class="pre">MEDIUM</span></code><em class="property"> <span class="pre">=</span> <span class="pre">RestartPriority(string='MEDIUM')</span></em><a class="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
virtual machine needs.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ServiceState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Possible states of an HA service. All services support the disabled and
enabled states.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceState</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState.DISABLED">
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ServiceState(string='DISABLED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>HA service is disabled.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState.ENABLED">
<code class="sig-name descname"><span class="pre">ENABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ServiceState(string='ENABLED')</span></em><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.ServiceState.ENABLED" title="Permalink to this definition"></a></dt>
<dd><p>HA service is enabled.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">StorageVmReaction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The VM policy settings that determine the response to storage failures.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">StorageVmReaction</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.CLUSTER_DEFAULT">
<code class="sig-name descname"><span class="pre">CLUSTER_DEFAULT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageVmReaction(string='CLUSTER_DEFAULT')</span></em><a class="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
per-VM settings.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.DISABLED">
<code class="sig-name descname"><span class="pre">DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageVmReaction(string='DISABLED')</span></em><a class="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
Host Monitoring or VM Health Monitoring.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.RESTART_AGGRESSIVE">
<code class="sig-name descname"><span class="pre">RESTART_AGGRESSIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageVmReaction(string='RESTART_AGGRESSIVE')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.RESTART_CONSERVATIVE">
<code class="sig-name descname"><span class="pre">RESTART_CONSERVATIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageVmReaction(string='RESTART_CONSERVATIVE')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.StorageVmReaction.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">StorageVmReaction(string='WARNING')</span></em><a class="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
Host Monitoring or VM Health Monitoring.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VmMonitoringState</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">VmMonitoringState</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState.VM_AND_APP_MONITORING">
<code class="sig-name descname"><span class="pre">VM_AND_APP_MONITORING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VmMonitoringState(string='VM_AND_APP_MONITORING')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState.VM_MONITORING_DISABLED">
<code class="sig-name descname"><span class="pre">VM_MONITORING_DISABLED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VmMonitoringState(string='VM_MONITORING_DISABLED')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmMonitoringState.VM_MONITORING_ONLY">
<code class="sig-name descname"><span class="pre">VM_MONITORING_ONLY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VmMonitoringState(string='VM_MONITORING_ONLY')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VmReactionOnAPDCleared</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">VmReactionOnAPDCleared</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared.NONE">
<code class="sig-name descname"><span class="pre">NONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VmReactionOnAPDCleared(string='NONE')</span></em><a class="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
cleared.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared.RESET">
<code class="sig-name descname"><span class="pre">RESET</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VmReactionOnAPDCleared(string='RESET')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FailuresAndResponses.VmReactionOnAPDCleared.USE_CLUSTER_DEFAULT">
<code class="sig-name descname"><span class="pre">USE_CLUSTER_DEFAULT</span></code><em class="property"> <span class="pre">=</span> <span class="pre">VmReactionOnAPDCleared(string='USE_CLUSTER_DEFAULT')</span></em><a class="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
per-VM settings.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">FixedSizeSlotPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.FixedSizeSlotPolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>This policy allows setting a fixed slot size</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cpu</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The cpu component of the slot size (in MHz)</p></li>
<li><p><strong>memory</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The memory component of the slot size (in megabytes)</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">HaVmOverrides</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_restart_priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_additional_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_restart_priority_timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_isolation_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_datastore_with_pdl_failure_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_apd_failure_response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_apd_failover_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_apd_response_recovery</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vm_monitoring</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HaVmOverrides" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The VmOverrides data object contains the HA configuration settings for vm
as a override from cluster. All fields are optional.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reference to the virtual machine.</p></li>
<li><p><strong>vm_restart_priority</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.RestartPriority</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.IsolationResponse</span></code></a> or <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.VmReactionOnAPDCleared</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses.VmMonitoringState</span></code></a> or <code class="docutils literal notranslate"><span class="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>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">HeartBeatDataStores</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">heartbeat_datastore_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datastores</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HeartBeatDataStores</span></code> class contains attributes describing the
HeartBeatDataStores It contains cluster-wide configurations for vsphere HA.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>heartbeat_datastore_policy</strong> (<a class="reference internal" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate"><code class="xref py py-class docutils literal notranslate"><span class="pre">HeartBeatDataStores.HBDatastoreCandidate</span></code></a>) – </p></li>
<li><p><strong>datastores</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">HBDatastoreCandidate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The policy to determine the candidates from which vCenter Server can choose
heartbeat datastores.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">HBDatastoreCandidate</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate.ALL_FEASIBLE_DS">
<code class="sig-name descname"><span class="pre">ALL_FEASIBLE_DS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HBDatastoreCandidate(string='ALL_FEASIBLE_DS')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate.ALL_FEASIBLE_DS_WITH_USER_PREFERENCE">
<code class="sig-name descname"><span class="pre">ALL_FEASIBLE_DS_WITH_USER_PREFERENCE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HBDatastoreCandidate(string='ALL_FEASIBLE_DS_WITH_USER_PREFERENCE')</span></em><a class="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
not sufficient.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.HeartBeatDataStores.HBDatastoreCandidate.USER_SELECTED_DS">
<code class="sig-name descname"><span class="pre">USER_SELECTED_DS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">HBDatastoreCandidate(string='USER_SELECTED_DS')</span></em><a class="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>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VmToolsMonitoringSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">VmToolsMonitoringSettings</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cluster_settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failure_interval</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_up_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_failures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_failure_window</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VmToolsMonitoringSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>Maximum number of failures and automated resets allowed during the
time that <code class="xref py py-attr docutils literal notranslate"><span class="pre">VmToolsMonitoringSettings.max_failure_window</span></code>
specifies. If <code class="xref py py-attr docutils literal notranslate"><span class="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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The number of seconds for the window during which up to
<code class="xref py py-attr docutils literal notranslate"><span class="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>
<p>The default value is -1.</p>
</div></blockquote>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.</span></code><code class="sig-name descname"><span class="pre">VsphereHA</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failures_and_responses</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">admission_control</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heartbeat_datastores</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">advanced_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.ha_client.VsphereHA" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DasInfo</span></code> class contains attributes describing the HA specific
configurations of a cluster. It contains cluster-wide configurations for
DAS.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">FailuresAndResponses</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">AdmissionControl</span></code></a> or <code class="docutils literal notranslate"><span class="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> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">HeartBeatDataStores</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Configuration settings for heart beat data store policy.
If None or empty, the value is skipped.</p></li>
<li><p><strong>advanced_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.OptionValue</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Advanced settings.
If None or empty, the value is skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client">
<span id="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<a class="headerlink" href="#module-com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.</span></code><code class="sig-name descname"><span class="pre">HostDefaultInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checksum_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.HostDefaultInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Default VSAN service configuration to be used for hosts admitted to the
cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>checksum_enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">false</span></code>. Change this value to <code class="docutils literal notranslate"><span class="pre">false</span></code> shall not
affect any existing disk status. Changing this value to <code class="docutils literal notranslate"><span class="pre">true</span></code>
shall do disk enforcement check that all VSAN disks are checksum
enabled.````</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.</span></code><code class="sig-name descname"><span class="pre">VsanConfigInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_config</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster.vsan_client.VsanConfigInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="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>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Whether the VSAN service is enabled for the cluster.</p></li>
<li><p><strong>default_config</strong> (<a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostDefaultInfo</span></code></a> or <code class="docutils literal notranslate"><span class="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 <a class="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"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostDefaultInfo</span></code></a> have been
omitted.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.cis.html" class="btn btn-neutral float-right" title="com.vmware.cis package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.appliance.vcenter.settings.v1.config.components.inventory.html" class="btn btn-neutral float-left" title="com.vmware.appliance.vcenter.settings.v1.config.components.inventory package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink