Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
8e216b20a8
vsphere-automation-sdk-python/vsphere/8.0.0.1/com.vmware.esx.settings.clusters.enablement.html
aagrawal3 eccc4f4dcb
Added docs for vSphere 8.0GA 
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
2022-10-12 17:31:15 +05:30

1535 lines
122 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.esx.settings.clusters.enablement package &mdash; vSphere Automation SDK for Python. 8.0.0.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.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.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.esx.html">com.vmware.esx package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a> &raquo;</li>
<li><a href="com.vmware.esx.settings.clusters.html">com.vmware.esx.settings.clusters package</a> &raquo;</li>
<li>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">
<div class="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 headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.esx.settings.clusters.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 headline"></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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.enablement.configuration_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.enablement.configuration_client.</span></code><code class="sig-name descname"><span class="pre">Transition</span></code><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">vmware.vapi.bindings.stub.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. <strong>Warning:</strong>
This class is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EligibilityResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong> This class is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.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. <strong>Warning:</strong>
This attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.</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. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">vmware.vapi.bindings.enum.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. <strong>Warning:</strong> This
enumeration is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.ELIGIBLE">
<code class="sig-name descname"><span class="pre">ELIGIBLE</span></code><em class="property"> <span class="pre">=</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.
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.NOT_ELIGIBLE">
<code class="sig-name descname"><span class="pre">NOT_ELIGIBLE</span></code><em class="property"> <span class="pre">=</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.
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">EnableResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong> This class is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.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. <strong>Warning:</strong> This
attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.</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. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
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. <strong>Warning:</strong> This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.
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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">vmware.vapi.bindings.enum.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. <strong>Warning:</strong> This enumeration is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class
attribute is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.RUNNING">
<code class="sig-name descname"><span class="pre">RUNNING</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class attribute is available as
Technology Preview. These are early access APIs provided to test, automate
and provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology Preview APIs
might only be applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS">
<code class="sig-name descname"><span class="pre">SUCCESS</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class attribute is
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED">
<code class="sig-name descname"><span class="pre">SUCCESS_APPLY_INITIATED</span></code><em class="property"> <span class="pre">=</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.
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.FileSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">FileSpec</span></code><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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong> This class
is available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Filename of the imported configuration. <strong>Warning:</strong> This attribute
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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. <strong>Warning:</strong> This attribute
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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><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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong> This class is
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.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. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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. <strong>Warning:</strong> This attribute is available as Technology
Preview. These are early access APIs provided to test, automate and
provide feedback on the feature. Since this can change based on
feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.
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. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
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>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">vmware.vapi.bindings.enum.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. <strong>Warning:</strong> This
enumeration is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLED">
<code class="sig-name descname"><span class="pre">ENABLED</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class
attribute is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLE_IN_PROGRESS">
<code class="sig-name descname"><span class="pre">ENABLE_IN_PROGRESS</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class attribute is available as Technology
Preview. These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback, VMware
does not guarantee backwards compatibility and recommends against using
them in production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE">
<code class="sig-name descname"><span class="pre">NOT_ALLOWED_IN_CURRENT_STATE</span></code><em class="property"> <span class="pre">=</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.
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_STARTED">
<code class="sig-name descname"><span class="pre">NOT_STARTED</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class
attribute is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.SOFTWARE_SPECIFICATION_NOT_SET">
<code class="sig-name descname"><span class="pre">SOFTWARE_SPECIFICATION_NOT_SET</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class attribute is available as Technology
Preview. These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback, VMware
does not guarantee backwards compatibility and recommends against using
them in production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED">
<code class="sig-name descname"><span class="pre">STARTED</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This class attribute is
available as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility and
recommends against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ReferenceHost">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ReferenceHost</span></code><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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong>
This class is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Reference host ID. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
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. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Source</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">vmware.vapi.bindings.enum.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. <strong>Warning:</strong> This
enumeration is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature. Since this
can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.FILE">
<code class="sig-name descname"><span class="pre">FILE</span></code><em class="property"> <span class="pre">=</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.
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.HOST">
<code class="sig-name descname"><span class="pre">HOST</span></code><em class="property"> <span class="pre">=</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.
<strong>Warning:</strong> This class attribute is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong> This class is available as Technology Preview. These
are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>author</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Author of transition. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</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. <strong>Warning:</strong> This
attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.</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. <strong>Warning:</strong> This
attribute is available as Technology Preview. These are early
access APIs provided to test, automate and provide feedback on the
feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them
in production environments. Some Technology Preview APIs might only
be applicable to specific environments.</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. <strong>Warning:</strong> This attribute is
available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</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. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
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. <strong>Warning:</strong> This attribute
is available as Technology Preview. These are early access APIs
provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.
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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ValidateResult</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">vmware.vapi.bindings.struct.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. <strong>Warning:</strong> This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback
on the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.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. <strong>Warning:</strong> This attribute is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.</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.
<strong>Warning:</strong> This attribute is available as Technology Preview.
These are early access APIs provided to test, automate and provide
feedback on the feature. Since this can change based on feedback,
VMware does not guarantee backwards compatibility and recommends
against using them in production environments. Some Technology
Preview APIs might only be applicable to specific environments.
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. <strong>Warning:</strong> This attribute is available
as Technology Preview. These are early access APIs provided to
test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable
to specific environments.
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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">vmware.vapi.bindings.enum.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. <strong>Warning:</strong>
This enumeration is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.INVALID">
<code class="sig-name descname"><span class="pre">INVALID</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This
class attribute is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.VALID">
<code class="sig-name descname"><span class="pre">VALID</span></code><em class="property"> <span class="pre">=</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. <strong>Warning:</strong> This
class attribute is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature. Since
this can change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production environments.
Some Technology Preview APIs might only be applicable to specific
environments.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><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. <strong>Warning:</strong> This method is available as
Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</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</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</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</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</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</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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.check_eligibility_task">
<code class="sig-name descname"><span class="pre">check_eligibility_task</span></code><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. <strong>Warning:</strong>
This method is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</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</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</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>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.enable_task">
<code class="sig-name descname"><span class="pre">enable_task</span></code><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. <strong>Warning:</strong> This method is
available as Technology Preview. These are early access APIs provided
to test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</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</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</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>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.export_config">
<code class="sig-name descname"><span class="pre">export_config</span></code><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>. <strong>Warning:</strong> This method is
available as Technology Preview. These are early access APIs provided
to test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</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</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</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</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</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</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</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</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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.export_schema">
<code class="sig-name descname"><span class="pre">export_schema</span></code><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>. <strong>Warning:</strong> This method is
available as Technology Preview. These are early access APIs provided
to test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</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</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</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</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</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</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</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</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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.get">
<code class="sig-name descname"><span class="pre">get</span></code><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.
<strong>Warning:</strong> This method is available as Technology Preview. These are
early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</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</dt>
<dd class="field-odd"><p>The transition state of the cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_file">
<code class="sig-name descname"><span class="pre">import_from_file</span></code><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.
<strong>Warning:</strong> This method is available as Technology Preview. These are
early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not
guarantee backwards compatibility and recommends against using them in
production environments. Some Technology Preview APIs might only be
applicable to specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</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</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</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</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</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.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 id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_host_task">
<code class="sig-name descname"><span class="pre">import_from_host_task</span></code><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. <strong>Warning:</strong>
This method is available as Technology Preview. These are early access
APIs provided to test, automate and provide feedback on the feature.
Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</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</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</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</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</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>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.precheck_task">
<code class="sig-name descname"><span class="pre">precheck_task</span></code><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. <strong>Warning:</strong> This method is
available as Technology Preview. These are early access APIs provided
to test, automate and provide feedback on the feature. Since this can
change based on feedback, VMware does not guarantee backwards
compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to
specific environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</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</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</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>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.validate_config_task">
<code class="sig-name descname"><span class="pre">validate_config_task</span></code><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. <strong>Warning:</strong> This method is available
as Technology Preview. These are early access APIs provided to test,
automate and provide feedback on the feature. Since this can change
based on feedback, VMware does not guarantee backwards compatibility
and recommends against using them in production environments. Some
Technology Preview APIs might only be applicable to specific
environments.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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</dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class</dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Task instance</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-even">Raise</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</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</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>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.esx.settings.clusters.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>
<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>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink