Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
0c2294f46c
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.esx.settings.clusters.policies.html

404 lines
36 KiB
HTML
Raw Normal View History

Updated VC docs for v8.0.3.0 (#424) Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com> Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 08:14:27 -04:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.esx.settings.clusters.policies package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script 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.esx.settings.clusters.software package" href="com.vmware.esx.settings.clusters.software.html" />
<link rel="prev" title="com.vmware.esx.settings.clusters.enablement package" href="com.vmware.esx.settings.clusters.enablement.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">
8.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" aria-label="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="Navigation menu">
<p class="caption" role="heading"><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.esx_client">com.vmware.esx_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.snapservice_client">com.vmware.snapservice_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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.esx.html">com.vmware.esx package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a></li>
<li class="breadcrumb-item active">com.vmware.esx.settings.clusters.policies package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.esx.settings.clusters.policies.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">
<section id="module-com.vmware.esx.settings.clusters.policies">
<span id="com-vmware-esx-settings-clusters-policies-package"></span><h1>com.vmware.esx.settings.clusters.policies package<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.policies" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.esx.settings.clusters.policies.apply_client">
<span id="com-vmware-esx-settings-clusters-policies-apply-client-module"></span><h2>com.vmware.esx.settings.clusters.policies.apply_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.policies.apply_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client</span></code> module provides
classes to manage policies that affect application of desired state
configuration and software for an ESXi cluster. Copyright 2019-2023 VMware,
Inc. All rights reserved. VMware Confidential Copyright 2019-2023 VMware, Inc.
All rights reserved. VMware Confidential</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client.</span></span><span class="sig-name descname"><span class="pre">Effective</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Effective</span></code> class provides methods to manage the effective policies
that will impact how the software and configuration specification documents
are applied to an ESXi cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EffectivePolicySpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_action</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">pre_remediation_power_action</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">enable_quick_boot</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">disable_dpm</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">disable_hac</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">evacuate_offline_vms</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">enforce_hcl_validation</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">parallel_remediation_action</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">enforce_quick_patch</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">config_manager_policy_spec</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.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code> class contains attributes that
describe the effective policies to be used when the software and
configuration specification documents are applied to an ESXi 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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>failure_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code></a>) – What action is to be taken if entering maintenance mode fails on a
given host of the cluster.</p></li>
<li><p><strong>pre_remediation_power_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code></a>) – Specifies what should be done to the power state of the VM before
entering maintenance mode.</p></li>
<li><p><strong>enable_quick_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enable Quick Boot during remediation in the cluster.</p></li>
<li><p><strong>disable_dpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Disable DPM on the cluster.</p></li>
<li><p><strong>disable_hac</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Disable HA Admission control on the cluster.</p></li>
<li><p><strong>evacuate_offline_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Evacuate powered off/suspended VMs when attempting maintenance
mode.</p></li>
<li><p><strong>enforce_hcl_validation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enforce Hcl validation, when applicable, to prevent remediation if
hardware compatibility issues are found. This attribute was added
in vSphere API 7.0.1.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>parallel_remediation_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.ParallelRemediationAction" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.ParallelRemediationAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.ParallelRemediationAction</span></code></a>) – Enable parallel remediation of hosts in maintenance mode. This
attribute was added in vSphere API 8.0.0.1.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>enforce_quick_patch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enforce quick patch on the cluster for images that support it. This
attribute was added in vSphere API 8.0.3.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>config_manager_policy_spec</strong> (<a class="reference internal" href="com.vmware.esx.settings.clusters.html#com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec" title="com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec</span></code></a>) – Configure settings applicable to the
com.vmware.esx.settings.clusters.Configuration.apply API. This
attribute was added in vSphere API 8.0.3.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PreRemediationPowerAction</span></span><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.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code> class
defines the possible actions to be taken, before entering maintenance mode.</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="bora/vspherevmodl2/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<span class="colon">:</span></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">PreRemediationPowerAction</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE">
<span class="sig-name descname"><span class="pre">DO_NOT_CHANGE_VMS_POWER_STATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE" title="Permalink to this definition"></a></dt>
<dd><p>Do not change the VM power state</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS">
<span class="sig-name descname"><span class="pre">POWER_OFF_VMS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='POWER_OFF_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS" title="Permalink to this definition"></a></dt>
<dd><p>Power off VMs before entering maintenance mode.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS">
<span class="sig-name descname"><span class="pre">SUSPEND_VMS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS" title="Permalink to this definition"></a></dt>
<dd><p>Suspend VMs before entering maintenance mode</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY">
<span class="sig-name descname"><span class="pre">SUSPEND_VMS_TO_MEMORY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY" title="Permalink to this definition"></a></dt>
<dd><p>Suspend VMs to Memory before entering maintenance mode. This class
attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FailureAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</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">retry_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">retry_count</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.esx.settings.clusters.policies.apply_client.Effective.FailureAction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code> class contains attributes that describe the
actions to be taken when entering maintenance mode fails on a single host
within the cluster.</p>
<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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code></a>) – What action (FAIL, RETRY) is to be taken if entering maintenance
mode fails on a single host within the cluster.</p></li>
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time to wait to retry the failed operation in seconds.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a>.</p></li>
<li><p><strong>retry_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of times to retry the failed operation.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Action</span></span><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.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code> class defines the actions to be
taken when entering maintenance mode fails on a single host within 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="bora/vspherevmodl2/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<span class="colon">:</span></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">Action</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL">
<span class="sig-name descname"><span class="pre">FAIL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Action(string='FAIL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL" title="Permalink to this definition"></a></dt>
<dd><p>Fail the apply method</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY">
<span class="sig-name descname"><span class="pre">RETRY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Action(string='RETRY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY" title="Permalink to this definition"></a></dt>
<dd><p>Retry the task Apply.FailureAction#retryCount number of times on the failed
host after Apply.FailureAction#retryDelay.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.ParallelRemediationAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ParallelRemediationAction</span></span><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">max_hosts</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.esx.settings.clusters.policies.apply_client.Effective.ParallelRemediationAction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">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<span class="colon">:</span></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>) – Enable parallel remediation for hosts in maintenance mode within a
cluster. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>max_hosts</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>) – Maximum number of hosts that can be remediated in parallel. Setting
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.policies_client.Apply.ParallelRemediationAction.max_hosts</span></code>
does not guarantee maxHosts to be remediated in parallel. This
attribute was added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the effective apply policy based on system defaults and what
has been configured for the cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The effective policies that impact the apply method on this
cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is an unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies.apply_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><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.esx.settings.clusters.policies.apply_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></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>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.esx.settings.clusters.enablement.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.clusters.enablement package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.esx.settings.clusters.software.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.clusters.software package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, 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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink