mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 09:39:58 -05:00
1160 lines
108 KiB
HTML
1160 lines
108 KiB
HTML
|
<!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.enablement package — 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.policies package" href="com.vmware.esx.settings.clusters.policies.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.esx.settings.clusters.configuration package" href="com.vmware.esx.settings.clusters.configuration.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.enablement package</li>
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
<a href="_sources/com.vmware.esx.settings.clusters.enablement.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.enablement">
|
|||
|
|
<span id="com-vmware-esx-settings-clusters-enablement-package"></span><h1>com.vmware.esx.settings.clusters.enablement package<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.enablement" 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.enablement.configuration_client">
|
|||
|
|
<span id="com-vmware-esx-settings-clusters-enablement-configuration-client-module"></span><h2>com.vmware.esx.settings.clusters.enablement.configuration_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.enablement.configuration_client" title="Permalink to this heading"></a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.enablement.configuration_client</span></code> module
|
|||
|
|
provides classes to manage enablement of configuration on an ESX cluster.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_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.enablement.configuration_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.enablement.configuration_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>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition">
|
|||
|
|
<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.enablement.configuration_client.</span></span><span class="sig-name descname"><span class="pre">Transition</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.enablement.configuration_client.Transition" 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">Transition</span></code> class provides methods to manage transition of an
|
|||
|
|
existing cluster to a desired configuration managed cluster. This class was
|
|||
|
|
added in vSphere API 8.0.1.0.</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.enablement.configuration_client.Transition.EligibilityResult">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EligibilityResult</span></span><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">notifications</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.enablement.configuration_client.Transition.EligibilityResult" 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>This <code class="docutils literal notranslate"><span class="pre">Transition.EligibilityResult</span></code> class contains attributes that
|
|||
|
|
describe the result of the eligibility checks performed on the cluster to
|
|||
|
|
determine if the cluster can transition to desired configuration management
|
|||
|
|
platform. This class was added in vSphere API 8.0.1.0.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.EligibilityResult.Status</span></code></a>) – Status of eligibility checks performed on a cluster. This attribute
|
|||
|
|
was added in vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Notifications providing additional information about the status of
|
|||
|
|
eligibility checks. This attribute was added in vSphere API
|
|||
|
|
8.0.1.0.
|
|||
|
|
This field is None when <code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.EligibilityResult.status</span></code>
|
|||
|
|
is ELLIGIBLE.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</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.enablement.configuration_client.Transition.EligibilityResult.Status" 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">Transition.EligibilityResult.Status</span></code> class contains the possible
|
|||
|
|
status codes describing the result of eligibility checks. This enumeration
|
|||
|
|
was added in vSphere API 8.0.1.0.</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">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.ELIGIBLE">
|
|||
|
|
<span class="sig-name descname"><span class="pre">ELIGIBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ELIGIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.ELIGIBLE" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This indicates that the cluster meets all the eligibility requirements.
|
|||
|
|
This class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.NOT_ELIGIBLE">
|
|||
|
|
<span class="sig-name descname"><span class="pre">NOT_ELIGIBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='NOT_ELIGIBLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.NOT_ELIGIBLE" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This indicates that the cluster does not meet the eligibility requirements.
|
|||
|
|
This class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EnableResult</span></span><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">errors</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">apply_task_id</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.enablement.configuration_client.Transition.EnableResult" 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">Transition.EnableResult</span></code> class contains attributes that describes
|
|||
|
|
the result of enabling configmanager on a cluster as part of the transition
|
|||
|
|
process. This class was added in vSphere API 8.0.1.0.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.EnableResult.Status</span></code></a>) – Status of enabling configmanager on a cluster. This attribute was
|
|||
|
|
added in vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notification" title="com.vmware.esx.settings_client.Notification"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notification</span></code></a>) – List of errors if any. This attribute was added in vSphere API
|
|||
|
|
8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.ERROR" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.EnableResult.Status.ERROR</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>apply_task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – ID of the Apply task invoked once ConfigManager is enabled on the
|
|||
|
|
cluster. This attribute was added in vSphere API 8.0.1.0.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
|
|||
|
|
as a return value, the attribute will be an identifier for the
|
|||
|
|
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</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.enablement.configuration_client.Transition.EnableResult.Status" 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">Transition.EnableResult.Status</span></code> class contains the status of Enable
|
|||
|
|
API. This enumeration was added in vSphere API 8.0.1.0.</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">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.ERROR">
|
|||
|
|
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.ERROR" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Failed to enable ConfigManager on the cluster. This class attribute was
|
|||
|
|
added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.RUNNING">
|
|||
|
|
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.RUNNING" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The task is in-progress. This class attribute was added in vSphere API
|
|||
|
|
8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS">
|
|||
|
|
<span class="sig-name descname"><span class="pre">SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='SUCCESS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>ConfigMnager enabled on the cluster. This class attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED">
|
|||
|
|
<span class="sig-name descname"><span class="pre">SUCCESS_APPLY_INITIATED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='SUCCESS_APPLY_INITIATED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>ConfigMnager enabled on the cluster and remediation was initiated. This
|
|||
|
|
class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.FileSpec">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FileSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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</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.enablement.configuration_client.Transition.FileSpec" 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">Transition.FileSpec</span></code> contain attributes that contains the details of
|
|||
|
|
the file being imported during transition process. This class was added in
|
|||
|
|
vSphere API 8.0.1.0.</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>filename</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Filename of the imported configuration. This attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Configuration from the imported file. This attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Hints">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Hints</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">requires_reference_host</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.enablement.configuration_client.Transition.Hints" 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">Transition.Hints</span></code> contains attributes that specifies additional
|
|||
|
|
information about the transition workflow. This data should be used as
|
|||
|
|
guidelines throughout the transition process. This class was added in
|
|||
|
|
vSphere API 8.0.3.0.</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"><p><strong>requires_reference_host</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>) – This hint indicates whether a reference host is required to
|
|||
|
|
transition the cluster. This hint is set to true if the framework
|
|||
|
|
detects that cluster is not managed by vLCM. The value does not
|
|||
|
|
change based on the state of the transition workflow, or the value
|
|||
|
|
of the reference host, or status of the reference host. This
|
|||
|
|
attribute was added in vSphere API 8.0.3.0.
|
|||
|
|
If field is None then the reference host is not required.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><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">state</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">fast_track</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">hints</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.enablement.configuration_client.Transition.Info" 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">Transition.Info</span></code> class contains attributes that describe the current
|
|||
|
|
status of transition process in the cluster. This class was added in
|
|||
|
|
vSphere API 8.0.1.0.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.Info.Status</span></code></a>) – Status of transition on a cluster. This attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.State" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.State</span></code></a>) – State of the transition. This field is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if the cluster
|
|||
|
|
is currently being transitioned to desired configuration management
|
|||
|
|
platform. This attribute was added in vSphere API 8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a> or
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>fast_track</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Flag describing if fast transition workflow is eligible on the
|
|||
|
|
cluster. Fast transition allows user to enable desired
|
|||
|
|
configuration platform on the cluster with default configuration.
|
|||
|
|
The cluster is eligible if transition workflow is not started and
|
|||
|
|
the cluster is empty. This attribute was added in vSphere API
|
|||
|
|
8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.NOT_STARTED</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>hints</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Hints" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Hints"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.Hints</span></code></a>) – This field provides additional information about the transition
|
|||
|
|
workflow. 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.enablement.configuration_client.Transition.Info.Status">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</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.enablement.configuration_client.Transition.Info.Status" 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">Transition.Info.Status</span></code> class contains the possible status codes
|
|||
|
|
describing the transition state of the cluster. This enumeration was added
|
|||
|
|
in vSphere API 8.0.1.0.</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">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLED">
|
|||
|
|
<span class="sig-name descname"><span class="pre">ENABLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ENABLED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLED" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Transition has completed successfully and the cluster is managed through
|
|||
|
|
the desired configuration management platform. This class attribute was
|
|||
|
|
added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLE_IN_PROGRESS">
|
|||
|
|
<span class="sig-name descname"><span class="pre">ENABLE_IN_PROGRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ENABLE_IN_PROGRESS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLE_IN_PROGRESS" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Transition has started and <code class="xref py py-func docutils literal notranslate"><span class="pre">Transition.enable()</span></code> task is running on the
|
|||
|
|
cluster. This class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE">
|
|||
|
|
<span class="sig-name descname"><span class="pre">NOT_ALLOWED_IN_CURRENT_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">Status(string='NOT_ALLOWED_IN_CURRENT_STATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Cluster is not in a state to transition to desired configuration management
|
|||
|
|
platform. The cluster ends up in this state if another user identified by
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.State.author</span></code> has already started transition. This class
|
|||
|
|
attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_STARTED">
|
|||
|
|
<span class="sig-name descname"><span class="pre">NOT_STARTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='NOT_STARTED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_STARTED" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Transition has not started on the cluster. This class attribute was added
|
|||
|
|
in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.SOFTWARE_SPECIFICATION_NOT_SET">
|
|||
|
|
<span class="sig-name descname"><span class="pre">SOFTWARE_SPECIFICATION_NOT_SET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='SOFTWARE_SPECIFICATION_NOT_SET')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.SOFTWARE_SPECIFICATION_NOT_SET" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Desired software specification is not set on the cluster. This is a
|
|||
|
|
pre-requisite to transition a cluster to desired configuration management
|
|||
|
|
platform. This class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED">
|
|||
|
|
<span class="sig-name descname"><span class="pre">STARTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='STARTED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>Transition has started on the cluster. This class attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ReferenceHost">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ReferenceHost</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</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_info</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.enablement.configuration_client.Transition.ReferenceHost" 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">Transition.ReferenceHost</span></code> contains attributes that specify the
|
|||
|
|
reference host information used by the transition process. This class was
|
|||
|
|
added in vSphere API 8.0.1.0.</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>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reference host ID. This attribute was added in vSphere API 8.0.1.0.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
|
|||
|
|
return value, the attribute will be an identifier for the resource
|
|||
|
|
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
|||
|
|
<li><p><strong>host_info</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HostInfo" title="com.vmware.esx.settings_client.HostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HostInfo</span></code></a>) – Host Info for Reference host. This attribute was added in vSphere
|
|||
|
|
API 8.0.1.0.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Source</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.enablement.configuration_client.Transition.Source" 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">Transition.Source</span></code> class describes the possible sources for
|
|||
|
|
specifying the desired configuration of the cluster. This enumeration was
|
|||
|
|
added in vSphere API 8.0.1.0.</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">Source</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.FILE">
|
|||
|
|
<span class="sig-name descname"><span class="pre">FILE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Source(string='FILE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.FILE" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This indicates that desired configuration originated from a file. This
|
|||
|
|
class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.HOST">
|
|||
|
|
<span class="sig-name descname"><span class="pre">HOST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Source(string='HOST')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.HOST" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This indicates that desired configuration originated from a reference host.
|
|||
|
|
This class attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.State">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">State</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">author</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">start_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">modified_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">source</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</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">filename</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.enablement.configuration_client.Transition.State" 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">Transition.State</span></code> class contains attributes that describe the latest
|
|||
|
|
state of transitioning a cluster to desired configuration management
|
|||
|
|
platform. This class was added in vSphere API 8.0.1.0.</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>author</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Author of transition. This attribute was added in vSphere API
|
|||
|
|
8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The start time of the transition process. This attribute was added
|
|||
|
|
in vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>modified_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Last modified time of the transition process. This attribute was
|
|||
|
|
added in vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>source</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.Source</span></code></a>) – Source of reference configuration. This attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ReferenceHost" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ReferenceHost"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.ReferenceHost</span></code></a>) – Reference host. This attribute was added in vSphere API 8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">source</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.HOST" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.HOST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Source.HOST</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>filename</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Filename of the imported configuration. This attribute was added in
|
|||
|
|
vSphere API 8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">source</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.FILE" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Source.FILE</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ValidateResult</span></span><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">errors</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">compliance</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.enablement.configuration_client.Transition.ValidateResult" 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">Transition.ValidateResult</span></code> class contains attributes that describe
|
|||
|
|
the validity of the imported desired configuration, and compliance
|
|||
|
|
information. This class was added in vSphere API 8.0.1.0.</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>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.ValidateResult.Status</span></code></a>) – Status indicating whether the configuration draft validated
|
|||
|
|
successfully. This attribute was added in vSphere API 8.0.1.0.</p></li>
|
|||
|
|
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.esx.settings.clusters.html#com.vmware.esx.settings.clusters.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.ValidationError</span></code></a>) – Lists all validation errors identified in the configuration draft.
|
|||
|
|
This attribute was added in vSphere API 8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.INVALID" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.INVALID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.ValidateResult.Status.INVALID</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>compliance</strong> (<a class="reference internal" href="com.vmware.esx.settings.clusters.html#com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance" title="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance</span></code></a>) – Cluster Compliance result. This attribute was added in vSphere API
|
|||
|
|
8.0.1.0.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.VALID" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.VALID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.ValidateResult.Status.VALID</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status">
|
|||
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</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.enablement.configuration_client.Transition.ValidateResult.Status" 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">Transition.ValidateResult.Status</span></code> class contains the possible status
|
|||
|
|
codes describing the result of validating configuration draft. This
|
|||
|
|
enumeration was added in vSphere API 8.0.1.0.</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">Status</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.INVALID">
|
|||
|
|
<span class="sig-name descname"><span class="pre">INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.INVALID" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This indicates that the configuration draft is invalid. This class
|
|||
|
|
attribute was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.VALID">
|
|||
|
|
<span class="sig-name descname"><span class="pre">VALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='VALID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.VALID" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This indicates that the configuration draft is valid. This class attribute
|
|||
|
|
was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.cancel">
|
|||
|
|
<span class="sig-name descname"><span class="pre">cancel</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.enablement.configuration_client.Transition.cancel" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This API cancels the workflow to transition the cluster to desired
|
|||
|
|
configuration platform. If the status of transition is
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a>, the associated state
|
|||
|
|
information will be deleted. Otherwise, cancel will not be allowed and
|
|||
|
|
the API will throw an error. This method was added in vSphere API
|
|||
|
|
8.0.1.0.</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>) – Identifier of the cluster.
|
|||
|
|
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">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 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
If the status of transition process is not
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a>.</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.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-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.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-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.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-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.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.ClusterConfiguration.Modify</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.ClusterConfiguration.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.check_eligibility_task">
|
|||
|
|
<span class="sig-name descname"><span class="pre">check_eligibility_task</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.enablement.configuration_client.Transition.check_eligibility_task" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The API performs eligibility checks on the cluster to see if it can be
|
|||
|
|
transitioned to desired configuration management platform. This method
|
|||
|
|
was added in vSphere API 8.0.1.0.</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>) – Identifier of the cluster.
|
|||
|
|
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><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Task instance</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 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>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.enable_task">
|
|||
|
|
<span class="sig-name descname"><span class="pre">enable_task</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.enablement.configuration_client.Transition.enable_task" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The API enables ConfigManager on the cluster. Before setting the
|
|||
|
|
desired configuration state, the API verifies the eligibility of the
|
|||
|
|
cluster to transition to desired configuration platform. The API then
|
|||
|
|
validates and sets the configuration draft as the desired configuration
|
|||
|
|
of the cluster, thus enabling ConfigManager. The API finally initiates
|
|||
|
|
remediation by invoking Apply. Apply is not invoked if the cluster is
|
|||
|
|
empty. The API does not wait for remediation to complete before
|
|||
|
|
returning. If any of the above step fails, the API will fail and result
|
|||
|
|
will contain descriptive error messages. This method was added in
|
|||
|
|
vSphere API 8.0.1.0.</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>) – Identifier of the cluster.
|
|||
|
|
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><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Task instance</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 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>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.export_config">
|
|||
|
|
<span class="sig-name descname"><span class="pre">export_config</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.enablement.configuration_client.Transition.export_config" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This API will export configuration associated with the cluster
|
|||
|
|
generated as part of the transition workflow. The API will throw an
|
|||
|
|
error if the transition state is not
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a>. This method was added in
|
|||
|
|
vSphere API 8.0.1.0.</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>) – Identifier of the cluster on which operation should be performed.
|
|||
|
|
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.html#com.vmware.esx.settings.clusters.configuration_client.ExportResult" title="com.vmware.esx.settings.clusters.configuration_client.ExportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.ExportResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>This output structure of type
|
|||
|
|
<a class="reference internal" href="com.vmware.esx.settings.clusters.html#com.vmware.esx.settings.clusters.configuration_client.ExportResult" title="com.vmware.esx.settings.clusters.configuration_client.ExportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.ExportResult</span></code></a>
|
|||
|
|
contains the configuration document encoded as JSON.</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 some other 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
If the status of transition process is not
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a>.</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.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 the cluster is not found in the system.</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.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-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.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-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.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.ClusterConfiguration.Export</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.ClusterConfiguration.Export</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.export_schema">
|
|||
|
|
<span class="sig-name descname"><span class="pre">export_schema</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.enablement.configuration_client.Transition.export_schema" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This API will export schema associated with the cluster. The API will
|
|||
|
|
throw an error if the transition state is not
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a>. This method was added in
|
|||
|
|
vSphere API 8.0.1.0.</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>) – Identifier of the cluster on which operation should be performed.
|
|||
|
|
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.html#com.vmware.esx.settings.clusters.configuration_client.SchemaResult" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.SchemaResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>This output structure of type
|
|||
|
|
<a class="reference internal" href="com.vmware.esx.settings.clusters.html#com.vmware.esx.settings.clusters.configuration_client.SchemaResult" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.SchemaResult</span></code></a>
|
|||
|
|
containing the schema document encoded as JSON.</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 some other 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.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
|
|||
|
|
If the status of transition process is not
|
|||
|
|
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a>.</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.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 the cluster is not found in the system.</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.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-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.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-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.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.ClusterConfiguration.Export</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.ClusterConfiguration.Export</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.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.enablement.configuration_client.Transition.get" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>This API returns the current transition state of the cluster. This
|
|||
|
|
method was added in vSphere API 8.0.1.0.</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>) – Identifier of the cluster.
|
|||
|
|
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.enablement.configuration_client.Transition.Info" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>The transition state of the 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 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.ClusterConfiguration.View</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.ClusterConfiguration.View</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_file">
|
|||
|
|
<span class="sig-name descname"><span class="pre">import_from_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_file" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The API imports the desired configuration from a file. Import API does
|
|||
|
|
not validate the configuration against the schema. The result will
|
|||
|
|
specify if the configuration was imported successfully. The result will
|
|||
|
|
provide localized error message if the import operation failed. This
|
|||
|
|
method was added in vSphere API 8.0.1.0.</p>
|
|||
|
|
<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>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.FileSpec" title="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.FileSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transition.FileSpec</span></code></a>) – Input structure containing file information.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</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.html#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult" title="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.DraftImportResult</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Output structure containing the status of the operation and error
|
|||
|
|
if any.</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 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.ClusterConfiguration.Modify</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.ClusterConfiguration.Modify</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_host_task">
|
|||
|
|
<span class="sig-name descname"><span class="pre">import_from_host_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_host_task" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The API imports the desired configuration from a reference host in the
|
|||
|
|
cluster. The API also adds host-specific and host-overrides from the
|
|||
|
|
other hosts in the cluster. Import API does not validate the
|
|||
|
|
configuration against the schema. The result will specify if the
|
|||
|
|
configuration was imported successfully. The result will provide
|
|||
|
|
localized error message if the import operation failed. This method was
|
|||
|
|
added in vSphere API 8.0.1.0.</p>
|
|||
|
|
<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>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
|||
|
|
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the reference host
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-even"><p><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Task instance</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 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>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.precheck_task">
|
|||
|
|
<span class="sig-name descname"><span class="pre">precheck_task</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.enablement.configuration_client.Transition.precheck_task" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The API computes impact of transitioning the cluster to be managed by
|
|||
|
|
desired configuration platform. It also runs health checks to verify
|
|||
|
|
the cluster’s health before transitioning. The API returns the impact
|
|||
|
|
on the hosts in the cluster and the result of health checks from the
|
|||
|
|
cluster and hosts. Health checks are run only if the host needs be
|
|||
|
|
rebooted or put in maintenanceMode. This method was added in vSphere
|
|||
|
|
API 8.0.1.0.</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>) – Identifier of the cluster.
|
|||
|
|
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><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Task instance</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 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>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.validate_config_task">
|
|||
|
|
<span class="sig-name descname"><span class="pre">validate_config_task</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.enablement.configuration_client.Transition.validate_config_task" title="Permalink to this definition"></a></dt>
|
|||
|
|
<dd><p>The API validates the imported desired configuration against the schema
|
|||
|
|
and on the hosts with validation plugins. If the document is valid, the
|
|||
|
|
API will check all the hosts for compliance with the desired
|
|||
|
|
configuration. The API returns validation errors if the configuration
|
|||
|
|
is not valid on any of the host. If the configuration is valid, the API
|
|||
|
|
returns compliance information. This method was added in vSphere API
|
|||
|
|
8.0.1.0.</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>) – Identifier of the cluster.
|
|||
|
|
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><dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">class<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|||
|
|
<dd class="field-odd"><p>Task instance</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 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>
|
|||
|
|
</dl>
|
|||
|
|
</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.configuration.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings.clusters.configuration 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.policies.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.clusters.policies package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>© 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>
|