mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
469 lines
29 KiB
HTML
469 lines
29 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!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.esx.settings.clusters.policies package — vSphere Automation SDK for Python. 7.0.1.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 src="_static/language_data.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.esx.settings.clusters.software package" href="com.vmware.esx.settings.clusters.software.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.esx.settings.clusters package" href="com.vmware.esx.settings.clusters.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" alt="Documentation Home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.1.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.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> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>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">
|
|||
|
|
|
|||
|
|
<div class="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 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.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 headline">¶</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-2020 VMware,
|
|||
|
|
Inc. All rights reserved. VMware Confidential Copyright 2019-2020 VMware, Inc.
|
|||
|
|
All rights reserved. VMware Confidential</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.clusters.policies.apply_client.</code><code class="sig-name descname">Effective</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</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">vmware.vapi.bindings.stub.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</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 id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">EffectivePolicySpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">failure_action</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pre_remediation_power_action</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enable_quick_boot</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disable_dpm</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disable_hac</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">evacuate_offline_vms</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">enforce_hcl_validation</span><span class="o">=</span><span class="default_value">None</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">vmware.vapi.bindings.struct.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</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>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">PreRemediationPowerAction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">vmware.vapi.bindings.enum.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="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">PreRemediationPowerAction</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE">
|
|||
|
|
<code class="sig-name descname">DO_NOT_CHANGE_VMS_POWER_STATE</code><em class="property"> = PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</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 id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS">
|
|||
|
|
<code class="sig-name descname">POWER_OFF_VMS</code><em class="property"> = PreRemediationPowerAction(string='POWER_OFF_VMS')</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 id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS">
|
|||
|
|
<code class="sig-name descname">SUSPEND_VMS</code><em class="property"> = PreRemediationPowerAction(string='SUSPEND_VMS')</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>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">FailureAction</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">action</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry_delay</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retry_count</span><span class="o">=</span><span class="default_value">None</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">vmware.vapi.bindings.struct.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</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 id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</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">vmware.vapi.bindings.enum.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="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">Action</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL">
|
|||
|
|
<code class="sig-name descname">FAIL</code><em class="property"> = Action(string='FAIL')</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 id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY">
|
|||
|
|
<code class="sig-name descname">RETRY</code><em class="property"> = Action(string='RETRY')</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 method">
|
|||
|
|
<dt id="com.vmware.esx.settings.clusters.policies.apply_client.Effective.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</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</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</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</dt>
|
|||
|
|
<dd class="field-odd"><p>The effective policies that impact the apply method on this
|
|||
|
|
cluster.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</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</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</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</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</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 id="com.vmware.esx.settings.clusters.policies.apply_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.esx.settings.clusters.policies.apply_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</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">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>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<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"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.esx.settings.clusters.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.clusters package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© Copyright 2020, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/rtfd/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>
|