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
44eb68437b
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.esx.settings.clusters.html
bhagatp10 44eb68437b
Updated VC docs for v8.0.3.0 (#424) 
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>

Co-authored-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>
2024-07-03 17:44:27 +05:30

6354 lines
679 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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.esx.settings.clusters package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.esx.settings.clusters.configuration package" href="com.vmware.esx.settings.clusters.configuration.html" />
<link rel="prev" title="com.vmware.esx.settings package" href="com.vmware.esx.settings.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.esx.html">com.vmware.esx package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.esx.settings.html">com.vmware.esx.settings package</a></li>
<li class="breadcrumb-item active">com.vmware.esx.settings.clusters package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.esx.settings.clusters.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-com.vmware.esx.settings.clusters">
<span id="com-vmware-esx-settings-clusters-package"></span><h1>com.vmware.esx.settings.clusters package<a class="headerlink" href="#module-com.vmware.esx.settings.clusters" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html">com.vmware.esx.settings.clusters.configuration package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#module-com.vmware.esx.settings.clusters.configuration.reports_client">com.vmware.esx.settings.clusters.configuration.reports_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.LastApplyResult"><code class="docutils literal notranslate"><span class="pre">LastApplyResult</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.LastApplyResult.get"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.LastComplianceResult"><code class="docutils literal notranslate"><span class="pre">LastComplianceResult</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.LastComplianceResult.get"><code class="docutils literal notranslate"><span class="pre">LastComplianceResult.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.LastPrecheckResult"><code class="docutils literal notranslate"><span class="pre">LastPrecheckResult</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.LastPrecheckResult.get"><code class="docutils literal notranslate"><span class="pre">LastPrecheckResult.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.RecentTasks"><code class="docutils literal notranslate"><span class="pre">RecentTasks</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.RecentTasks.DraftTasks"><code class="docutils literal notranslate"><span class="pre">RecentTasks.DraftTasks</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.RecentTasks.Info"><code class="docutils literal notranslate"><span class="pre">RecentTasks.Info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.RecentTasks.get"><code class="docutils literal notranslate"><span class="pre">RecentTasks.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.configuration.html#com.vmware.esx.settings.clusters.configuration.reports_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html">com.vmware.esx.settings.clusters.enablement package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#module-com.vmware.esx.settings.clusters.enablement.configuration_client">com.vmware.esx.settings.clusters.enablement.configuration_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition"><code class="docutils literal notranslate"><span class="pre">Transition</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult"><code class="docutils literal notranslate"><span class="pre">Transition.EligibilityResult</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status"><code class="docutils literal notranslate"><span class="pre">Transition.EligibilityResult.Status</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.ELIGIBLE"><code class="docutils literal notranslate"><span class="pre">Transition.EligibilityResult.Status.ELIGIBLE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EligibilityResult.Status.NOT_ELIGIBLE"><code class="docutils literal notranslate"><span class="pre">Transition.EligibilityResult.Status.NOT_ELIGIBLE</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult"><code class="docutils literal notranslate"><span class="pre">Transition.EnableResult</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status"><code class="docutils literal notranslate"><span class="pre">Transition.EnableResult.Status</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.ERROR"><code class="docutils literal notranslate"><span class="pre">Transition.EnableResult.Status.ERROR</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.RUNNING"><code class="docutils literal notranslate"><span class="pre">Transition.EnableResult.Status.RUNNING</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS"><code class="docutils literal notranslate"><span class="pre">Transition.EnableResult.Status.SUCCESS</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED"><code class="docutils literal notranslate"><span class="pre">Transition.EnableResult.Status.SUCCESS_APPLY_INITIATED</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.FileSpec"><code class="docutils literal notranslate"><span class="pre">Transition.FileSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Hints"><code class="docutils literal notranslate"><span class="pre">Transition.Hints</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info"><code class="docutils literal notranslate"><span class="pre">Transition.Info</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLED"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status.ENABLED</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.ENABLE_IN_PROGRESS"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status.ENABLE_IN_PROGRESS</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.NOT_STARTED"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status.NOT_STARTED</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.SOFTWARE_SPECIFICATION_NOT_SET"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status.SOFTWARE_SPECIFICATION_NOT_SET</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Info.Status.STARTED"><code class="docutils literal notranslate"><span class="pre">Transition.Info.Status.STARTED</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ReferenceHost"><code class="docutils literal notranslate"><span class="pre">Transition.ReferenceHost</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source"><code class="docutils literal notranslate"><span class="pre">Transition.Source</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.FILE"><code class="docutils literal notranslate"><span class="pre">Transition.Source.FILE</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.Source.HOST"><code class="docutils literal notranslate"><span class="pre">Transition.Source.HOST</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.State"><code class="docutils literal notranslate"><span class="pre">Transition.State</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult"><code class="docutils literal notranslate"><span class="pre">Transition.ValidateResult</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status"><code class="docutils literal notranslate"><span class="pre">Transition.ValidateResult.Status</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.INVALID"><code class="docutils literal notranslate"><span class="pre">Transition.ValidateResult.Status.INVALID</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.ValidateResult.Status.VALID"><code class="docutils literal notranslate"><span class="pre">Transition.ValidateResult.Status.VALID</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.cancel"><code class="docutils literal notranslate"><span class="pre">Transition.cancel()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.check_eligibility_task"><code class="docutils literal notranslate"><span class="pre">Transition.check_eligibility_task()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.enable_task"><code class="docutils literal notranslate"><span class="pre">Transition.enable_task()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.export_config"><code class="docutils literal notranslate"><span class="pre">Transition.export_config()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.export_schema"><code class="docutils literal notranslate"><span class="pre">Transition.export_schema()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.get"><code class="docutils literal notranslate"><span class="pre">Transition.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_file"><code class="docutils literal notranslate"><span class="pre">Transition.import_from_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.import_from_host_task"><code class="docutils literal notranslate"><span class="pre">Transition.import_from_host_task()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.precheck_task"><code class="docutils literal notranslate"><span class="pre">Transition.precheck_task()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.enablement.html#com.vmware.esx.settings.clusters.enablement.configuration_client.Transition.validate_config_task"><code class="docutils literal notranslate"><span class="pre">Transition.validate_config_task()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html">com.vmware.esx.settings.clusters.policies package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#module-com.vmware.esx.settings.clusters.policies.apply_client">com.vmware.esx.settings.clusters.policies.apply_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective"><code class="docutils literal notranslate"><span class="pre">Effective</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec"><code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction"><code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE"><code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS"><code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction.POWER_OFF_VMS</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS"><code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY"><code class="docutils literal notranslate"><span class="pre">Effective.EffectivePolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction"><code class="docutils literal notranslate"><span class="pre">Effective.FailureAction</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action"><code class="docutils literal notranslate"><span class="pre">Effective.FailureAction.Action</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.FAIL"><code class="docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.FAIL</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.FailureAction.Action.RETRY"><code class="docutils literal notranslate"><span class="pre">Effective.FailureAction.Action.RETRY</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.ParallelRemediationAction"><code class="docutils literal notranslate"><span class="pre">Effective.ParallelRemediationAction</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.get"><code class="docutils literal notranslate"><span class="pre">Effective.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html">com.vmware.esx.settings.clusters.software package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html">com.vmware.esx.settings.clusters.software.drafts package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#module-com.vmware.esx.settings.clusters.software.drafts.software_client">com.vmware.esx.settings.clusters.software.drafts.software_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn"><code class="docutils literal notranslate"><span class="pre">AddOn</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">AddOn.RESOURCE_TYPE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.delete"><code class="docutils literal notranslate"><span class="pre">AddOn.delete()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.get"><code class="docutils literal notranslate"><span class="pre">AddOn.get()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.AddOn.set"><code class="docutils literal notranslate"><span class="pre">AddOn.set()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage"><code class="docutils literal notranslate"><span class="pre">BaseImage</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">BaseImage.RESOURCE_TYPE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.get"><code class="docutils literal notranslate"><span class="pre">BaseImage.get()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.BaseImage.set"><code class="docutils literal notranslate"><span class="pre">BaseImage.set()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components"><code class="docutils literal notranslate"><span class="pre">Components</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">Components.RESOURCE_TYPE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.UpdateSpec"><code class="docutils literal notranslate"><span class="pre">Components.UpdateSpec</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.delete"><code class="docutils literal notranslate"><span class="pre">Components.delete()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.get"><code class="docutils literal notranslate"><span class="pre">Components.get()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.list"><code class="docutils literal notranslate"><span class="pre">Components.list()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.set"><code class="docutils literal notranslate"><span class="pre">Components.set()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.Components.update"><code class="docutils literal notranslate"><span class="pre">Components.update()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents"><code class="docutils literal notranslate"><span class="pre">EffectiveComponents</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list"><code class="docutils literal notranslate"><span class="pre">EffectiveComponents.list()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.EffectiveComponents.list_with_removed_components"><code class="docutils literal notranslate"><span class="pre">EffectiveComponents.list_with_removed_components()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport"><code class="docutils literal notranslate"><span class="pre">HardwareSupport</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.delete"><code class="docutils literal notranslate"><span class="pre">HardwareSupport.delete()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.get"><code class="docutils literal notranslate"><span class="pre">HardwareSupport.get()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.HardwareSupport.set"><code class="docutils literal notranslate"><span class="pre">HardwareSupport.set()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents"><code class="docutils literal notranslate"><span class="pre">RemovedComponents</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.RESOURCE_TYPE"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.RESOURCE_TYPE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.delete"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.delete()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.get"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.get()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.list"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.list()</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.RemovedComponents.set"><code class="docutils literal notranslate"><span class="pre">RemovedComponents.set()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.drafts.html#com.vmware.esx.settings.clusters.software.drafts.software_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html">com.vmware.esx.settings.clusters.software.reports package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility package</a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#submodules">Submodules</a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client module</a><ul>
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a><ul>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.ComplianceAction</span></code></a><ul>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.FLAG_AS_INCOMPATIBLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.ComplianceAction.FLAG_AS_INCOMPATIBLE</span></code></a></li>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.MARK_AS_VERIFIED"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.ComplianceAction.MARK_AS_VERIFIED</span></code></a></li>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ComplianceAction.SUPPRESS_WARNING"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.ComplianceAction.SUPPRESS_WARNING</span></code></a></li>
</ul>
</li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Key"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.Key</span></code></a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.ReclassificationSpec"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.ReclassificationSpec</span></code></a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Service"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.Service</span></code></a><ul>
<li class="toctree-l9"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.Service.VSAN"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.Service.VSAN</span></code></a></li>
</ul>
</li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.UpdateSpec"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.UpdateSpec</span></code></a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.ComplianceStatus.update_task"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.update_task()</span></code></a></li>
</ul>
</li>
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries"><code class="docutils literal notranslate"><span class="pre">VcgEntries</span></code></a><ul>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.Key"><code class="docutils literal notranslate"><span class="pre">VcgEntries.Key</span></code></a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.ProductSelectionSpec"><code class="docutils literal notranslate"><span class="pre">VcgEntries.ProductSelectionSpec</span></code></a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.UpdateSpec"><code class="docutils literal notranslate"><span class="pre">VcgEntries.UpdateSpec</span></code></a></li>
<li class="toctree-l8"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility.storage_device_overrides_client.VcgEntries.update_task"><code class="docutils literal notranslate"><span class="pre">VcgEntries.update_task()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#module-com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client">com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details"><code class="docutils literal notranslate"><span class="pre">Details</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.Details.get"><code class="docutils literal notranslate"><span class="pre">Details.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.reports.html#com.vmware.esx.settings.clusters.software.reports.hardware_compatibility_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.drafts_client">com.vmware.esx.settings.clusters.software.drafts_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.drafts_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#module-com.vmware.esx.settings.clusters.software.reports_client">com.vmware.esx.settings.clusters.software.reports_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact"><code class="docutils literal notranslate"><span class="pre">ApplyImpact</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ApplyImpactSpec"><code class="docutils literal notranslate"><span class="pre">ApplyImpact.ApplyImpactSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.ClusterImpact"><code class="docutils literal notranslate"><span class="pre">ApplyImpact.ClusterImpact</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.Impact"><code class="docutils literal notranslate"><span class="pre">ApplyImpact.Impact</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ApplyImpact.get"><code class="docutils literal notranslate"><span class="pre">ApplyImpact.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.CheckResult"><code class="docutils literal notranslate"><span class="pre">CheckResult</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.COMPATIBLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.COMPATIBLE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.HCL_DATA_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.HCL_DATA_UNAVAILABLE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.INCOMPATIBLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.INCOMPATIBLE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.NO_FIRMWARE_PROVIDER"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.NO_FIRMWARE_PROVIDER</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatus.UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatus.UNAVAILABLE</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.CERTIFIED"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.CERTIFIED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.FIRMWARE_VERSION_UNKNOWN"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.FIRMWARE_VERSION_UNKNOWN</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.HCL_DATA_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.HCL_DATA_UNAVAILABLE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.HOSTS_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.HOSTS_UNAVAILABLE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.MUTED"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.MUTED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.NOT_CERTIFIED"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.NOT_CERTIFIED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.UNKNOWN"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.UNKNOWN</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.USER_FLAGGED"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.USER_FLAGGED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.USER_VERIFIED"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.USER_VERIFIED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.ComplianceStatusDetail.VENDOR_UPDATE"><code class="docutils literal notranslate"><span class="pre">ComplianceStatusDetail.VENDOR_UPDATE</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.DriverFirmwareVersion"><code class="docutils literal notranslate"><span class="pre">DriverFirmwareVersion</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.FirmwareVersionMatchingCriteria"><code class="docutils literal notranslate"><span class="pre">FirmwareVersionMatchingCriteria</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.FirmwareVersionMatchingCriteria.EXACT"><code class="docutils literal notranslate"><span class="pre">FirmwareVersionMatchingCriteria.EXACT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.FirmwareVersionMatchingCriteria.MINIMUM"><code class="docutils literal notranslate"><span class="pre">FirmwareVersionMatchingCriteria.MINIMUM</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.CheckSummary"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.CheckSummary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.COMPATIBLE"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus.COMPATIBLE</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.HCL_DATA_UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus.HCL_DATA_UNAVAILABLE</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.INCOMPATIBLE"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus.INCOMPATIBLE</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.NO_FIRMWARE_PROVIDER"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus.NO_FIRMWARE_PROVIDER</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.ComplianceStatus.UNAVAILABLE"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.ComplianceStatus.UNAVAILABLE</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.check_task"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.check_task()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.HardwareCompatibility.get"><code class="docutils literal notranslate"><span class="pre">HardwareCompatibility.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult"><code class="docutils literal notranslate"><span class="pre">LastApplyResult</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyResult"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyResult</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.ERROR"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status.ERROR</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.OK"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status.OK</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.RETRY_PENDING"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status.RETRY_PENDING</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.SKIPPED"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status.SKIPPED</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.ApplyStatus.Status.TIMED_OUT"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.ApplyStatus.Status.TIMED_OUT</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastApplyResult.get"><code class="docutils literal notranslate"><span class="pre">LastApplyResult.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult"><code class="docutils literal notranslate"><span class="pre">LastCheckResult</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckInfo"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckInfo</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckResult"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckResult</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.CheckStatus"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.CheckStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.CLUSTER"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType.CLUSTER</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.EntityCheckResult.EntityType.HOST"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.EntityCheckResult.EntityType.HOST</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.ERROR"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status.ERROR</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.OK"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status.OK</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.TIMEOUT"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status.TIMEOUT</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.Status.WARNING"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.Status.WARNING</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.LastCheckResult.get"><code class="docutils literal notranslate"><span class="pre">LastCheckResult.get()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.PciDevice"><code class="docutils literal notranslate"><span class="pre">PciDevice</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.PciDeviceCompliance"><code class="docutils literal notranslate"><span class="pre">PciDeviceCompliance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.PciDeviceComplianceInfo"><code class="docutils literal notranslate"><span class="pre">PciDeviceComplianceInfo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.PciDeviceConstraint"><code class="docutils literal notranslate"><span class="pre">PciDeviceConstraint</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.Service"><code class="docutils literal notranslate"><span class="pre">Service</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.Service.VSAN"><code class="docutils literal notranslate"><span class="pre">Service.VSAN</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompatibility"><code class="docutils literal notranslate"><span class="pre">StorageDeviceCompatibility</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceCompliance"><code class="docutils literal notranslate"><span class="pre">StorageDeviceCompliance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceComplianceInfo"><code class="docutils literal notranslate"><span class="pre">StorageDeviceComplianceInfo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceConstraint"><code class="docutils literal notranslate"><span class="pre">StorageDeviceConstraint</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.StorageDeviceInfo"><code class="docutils literal notranslate"><span class="pre">StorageDeviceInfo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.esx.settings.clusters.software.html#com.vmware.esx.settings.clusters.software.reports_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.esx.settings.clusters.configuration_client">
<span id="com-vmware-esx-settings-clusters-configuration-client-module"></span><h2>com.vmware.esx.settings.clusters.configuration_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.configuration_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client</span></code> module provides
classes to manage the configuration of an ESX cluster. The
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration.reports_client</span></code> module
provides classes for accessing reports regarding the configuration state of the
cluster.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">AuditRecords</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AuditRecords</span></code> class provides methods to get the auditing records of
the configuration actions performed on a cluster in vCenter Server. This
class was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">operations</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">usernames</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">time_duration</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">time_period</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.configuration_client.AuditRecords.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AuditRecords.FilterSpec</span></code> class contains attributes used to filter
the audit records. If multiple attributes are specified, only records
matching all of the attributes match the filter. This class was added in
vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>operations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>List of audit records that match the given operations An operation
in operations can be any of</p>
<ul>
<li><p>Import</p></li>
<li><p>Export</p></li>
<li><p>Remediate</p></li>
<li><p>Checkcompliance</p></li>
<li><p>Precheck</p></li>
<li><p>Transition-Enable</p></li>
<li><p>Draft-List</p></li>
<li><p>Draft-Create</p></li>
<li><p>Draft-ImportFromHost</p></li>
<li><p>Draft-Get</p></li>
<li><p>Draft-ExportConfig</p></li>
<li><p>Draft-Update</p></li>
<li><p>Draft-ShowChanges</p></li>
<li><p>Draft-CheckCompliance</p></li>
<li><p>Draft-Precheck</p></li>
<li><p>Draft-Delete</p></li>
<li><p>Draft-Apply</p></li>
</ul>
<p>. This attribute was added in vSphere API 8.0.2.0.
If None or empty, records with any operation match the filter.</p>
</p></li>
<li><p><strong>usernames</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of audit records that match the given users. This attribute
was added in vSphere API 8.0.2.0.
If None or empty, records with any users match the filter.</p></li>
<li><p><strong>time_duration</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditRecords.FilterSpec.Timeframe</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of audit records that match
<code class="docutils literal notranslate"><span class="pre">AuditRecords.FilterSpec.Timeframe</span></code>, valid values are
THREE_MONTHS, SIX_MONTHS, YEAR, CUSTOM. i.e. For ex: records within
last 3 months. This attribute was added in vSphere API 8.0.2.0.
If None or empty, last one year audit records match the filter.</p></li>
<li><p><strong>time_period</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.TimePeriod" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.TimePeriod"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditRecords.TimePeriod</span></code></a>) – List of audit records that match the given start time i.e. occurred
after the <code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.TimePeriod.start</span></code> and the given end
time i.e. before the <code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.TimePeriod.end</span></code>. This
attribute was added in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">timeDuration</span></code> is
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.CUSTOM" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.CUSTOM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.FilterSpec.Timeframe.CUSTOM</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Timeframe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>List of audit records that match the given time frame i.e. For ex: occurred
within last 30 days. This enumeration was added in vSphere API 8.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Timeframe</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.CUSTOM">
<span class="sig-name descname"><span class="pre">CUSTOM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Timeframe(string='CUSTOM')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.CUSTOM" title="Permalink to this definition"></a></dt>
<dd><p>To indicate custom time frame for getting audit records. Users can specify
start time and end time. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.SIX_MONTHS">
<span class="sig-name descname"><span class="pre">SIX_MONTHS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Timeframe(string='SIX_MONTHS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.SIX_MONTHS" title="Permalink to this definition"></a></dt>
<dd><p>To indicate last 6 months audit records. This class attribute was added in
vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.THREE_MONTHS">
<span class="sig-name descname"><span class="pre">THREE_MONTHS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Timeframe(string='THREE_MONTHS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.THREE_MONTHS" title="Permalink to this definition"></a></dt>
<dd><p>To indicate last 3 months audit records. This class attribute was added in
vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.YEAR">
<span class="sig-name descname"><span class="pre">YEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Timeframe(string='YEAR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec.Timeframe.YEAR" title="Permalink to this definition"></a></dt>
<dd><p>To indicate last 1 year audit records. This class attribute was added in
vSphere API 8.0.2.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster_id</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">operation</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">username</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">end_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">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">operation_details</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.configuration_client.AuditRecords.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AuditRecords.Info</span></code> class contains Audit Info of an operation for a
cluster in vCenter Server. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster. This attribute was added in vSphere API
8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</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">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>operation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Name of the operation which can be one of</p>
<ul>
<li><p>Import</p></li>
<li><p>Export</p></li>
<li><p>Remediate</p></li>
<li><p>Checkcompliance</p></li>
<li><p>Precheck</p></li>
<li><p>Transition-Enable</p></li>
<li><p>Draft-List</p></li>
<li><p>Draft-Create</p></li>
<li><p>Draft-ImportFromHost</p></li>
<li><p>Draft-Get</p></li>
<li><p>Draft-ExportConfig</p></li>
<li><p>Draft-Update</p></li>
<li><p>Draft-ShowChanges</p></li>
<li><p>Draft-CheckCompliance</p></li>
<li><p>Draft-Precheck</p></li>
<li><p>Draft-Delete</p></li>
<li><p>Draft-Apply</p></li>
</ul>
<p>. This attribute was added in vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be one of <code class="docutils literal notranslate"><span class="pre">Import</span></code>, <code class="docutils literal notranslate"><span class="pre">Export</span></code>, <code class="docutils literal notranslate"><span class="pre">Remediate</span></code>,
<code class="docutils literal notranslate"><span class="pre">Checkcompliance</span></code>, <code class="docutils literal notranslate"><span class="pre">Precheck</span></code>, <code class="docutils literal notranslate"><span class="pre">Transition-Enable</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-List</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-Create</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-ImportFromHost</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-Get</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-ExportConfig</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-Update</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-ShowChanges</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-CheckCompliance</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-Precheck</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-Delete</span></code>, or <code class="docutils literal notranslate"><span class="pre">Draft-Apply</span></code>. When
methods return a value of this class as a return value, the
attribute will be one of <code class="docutils literal notranslate"><span class="pre">Import</span></code>, <code class="docutils literal notranslate"><span class="pre">Export</span></code>, <code class="docutils literal notranslate"><span class="pre">Remediate</span></code>,
<code class="docutils literal notranslate"><span class="pre">Checkcompliance</span></code>, <code class="docutils literal notranslate"><span class="pre">Precheck</span></code>, <code class="docutils literal notranslate"><span class="pre">Transition-Enable</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-List</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-Create</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-ImportFromHost</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-Get</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-ExportConfig</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-Update</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-ShowChanges</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-CheckCompliance</span></code>,
<code class="docutils literal notranslate"><span class="pre">Draft-Precheck</span></code>, <code class="docutils literal notranslate"><span class="pre">Draft-Delete</span></code>, or <code class="docutils literal notranslate"><span class="pre">Draft-Apply</span></code>.</p>
</p></li>
<li><p><strong>username</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User who initiated the operation. This attribute was added in
vSphere API 8.0.2.0.</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Time when the operation <code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.Info.operation</span></code> was
started. This attribute was added in vSphere API 8.0.2.0.
startTime might not be available for a task.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Time when the operation <code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.Info.operation</span></code> was
completed. This attribute was added in vSphere API 8.0.2.0.
endTime might not be available for a task.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="com.vmware.cis.html#com.vmware.cis.task_client.Status" title="com.vmware.cis.task_client.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.cis.task_client.Status</span></code></a>) – Status of the operation <code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.Info.operation</span></code>. This
attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>operation_details</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationDetails" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditRecords.OperationDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details of the operation. This attribute was added in vSphere API
8.0.2.0.
operationdetails might not be available for an operation which is
not a task.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OperationDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</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">task_id</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">draft_id</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">cancelled</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.configuration_client.AuditRecords.OperationDetails" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AuditRecords.OperationDetails</span></code> class contains Operation Details of
an operation. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Error occurred during the operation. This attribute was added in
vSphere API 8.0.2.0.
error shall only be set if configmanager operation is a task</p></li>
<li><p><strong>task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – TaskId of the operation. This attribute was added in vSphere API
8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
taskId shall only be set if configmanager operation is a task</p></li>
<li><p><strong>draft_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Draft ID of the draft operation. This attribute was added in
vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</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.esx.settings.draft</span></code>.
draftId shall only be set if this is an operaton on draft</p></li>
<li><p><strong>cancelled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Indicates if the operation was cancelled. This attribute was added
in vSphere API 8.0.2.0.
cancelled shall only be set if configmanager operation is a task</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OperationType</span></span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AuditRecords.OperationType</span></code> class contains class attributes used to
represent all possible config manager operations. This class was added in
vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.CHECK_COMPLIANCE">
<span class="sig-name descname"><span class="pre">CHECK_COMPLIANCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Checkcompliance'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.CHECK_COMPLIANCE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Check compliance config manager operation
com.vmware.esx.settings.clusters.. This class attribute was added in vSphere
API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_APPLY">
<span class="sig-name descname"><span class="pre">DRAFT_APPLY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-Apply'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_APPLY" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Apply
com.vmware.esx.settings.clusters.configuration.Drafts#impact. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_CHECK_COMPLIANCE">
<span class="sig-name descname"><span class="pre">DRAFT_CHECK_COMPLIANCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-CheckCompliance'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_CHECK_COMPLIANCE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Check Compliance
<a class="reference internal" href="#module-com.vmware.esx.settings.clusters.configuration_client" title="com.vmware.esx.settings.clusters.configuration_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_CREATE">
<span class="sig-name descname"><span class="pre">DRAFT_CREATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-Create'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_CREATE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Create <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.create" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.create"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.create()</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_DELETE">
<span class="sig-name descname"><span class="pre">DRAFT_DELETE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-Delete'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_DELETE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Delete <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.delete" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.delete"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.delete()</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_EXPORT_CONFIG">
<span class="sig-name descname"><span class="pre">DRAFT_EXPORT_CONFIG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-ExportConfig'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_EXPORT_CONFIG" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Export Config
<a class="reference internal" href="#module-com.vmware.esx.settings.clusters.configuration_client" title="com.vmware.esx.settings.clusters.configuration_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_GET">
<span class="sig-name descname"><span class="pre">DRAFT_GET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-Get'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_GET" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Get <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.get" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.get()</span></code></a>. This class attribute was
added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_IMPORT_FROM_HOST">
<span class="sig-name descname"><span class="pre">DRAFT_IMPORT_FROM_HOST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-ImportFromHost'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_IMPORT_FROM_HOST" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Import from host
<a class="reference internal" href="#module-com.vmware.esx.settings.clusters.configuration_client" title="com.vmware.esx.settings.clusters.configuration_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_LIST">
<span class="sig-name descname"><span class="pre">DRAFT_LIST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-List'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_LIST" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft List <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.list" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.list()</span></code></a>. This class attribute
was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_PRECHECK">
<span class="sig-name descname"><span class="pre">DRAFT_PRECHECK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-Precheck'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_PRECHECK" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Precheck
<a class="reference internal" href="#module-com.vmware.esx.settings.clusters.configuration_client" title="com.vmware.esx.settings.clusters.configuration_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_SHOW_CHANGES">
<span class="sig-name descname"><span class="pre">DRAFT_SHOW_CHANGES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-ShowChanges'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_SHOW_CHANGES" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Show Changes
<a class="reference internal" href="#module-com.vmware.esx.settings.clusters.configuration_client" title="com.vmware.esx.settings.clusters.configuration_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.configuration_client</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_UPDATE">
<span class="sig-name descname"><span class="pre">DRAFT_UPDATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Draft-Update'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.DRAFT_UPDATE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Configmanager Draft Update <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.update" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.update()</span></code></a>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.EXPORT">
<span class="sig-name descname"><span class="pre">EXPORT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Export'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.EXPORT" title="Permalink to this definition"></a></dt>
<dd><p>Represents Export config manager operation
<a class="reference internal" href="com.vmware.esx.settings.html#com.vmware.esx.settings.clusters_client.Configuration.export_config" title="com.vmware.esx.settings.clusters_client.Configuration.export_config"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters_client.Configuration.export_config()</span></code></a>.
This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.IMPORT">
<span class="sig-name descname"><span class="pre">IMPORT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Import'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.IMPORT" title="Permalink to this definition"></a></dt>
<dd><p>Represents Import config manager operation
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters_client.Configuration.import_config()</span></code>.
This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.OPERATIONS">
<span class="sig-name descname"><span class="pre">OPERATIONS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['Import',</span> <span class="pre">'Export',</span> <span class="pre">'Remediate',</span> <span class="pre">'Checkcompliance',</span> <span class="pre">'Precheck',</span> <span class="pre">'Transition-Enable',</span> <span class="pre">'Draft-List',</span> <span class="pre">'Draft-Create',</span> <span class="pre">'Draft-ImportFromHost',</span> <span class="pre">'Draft-Get',</span> <span class="pre">'Draft-ExportConfig',</span> <span class="pre">'Draft-Update',</span> <span class="pre">'Draft-ShowChanges',</span> <span class="pre">'Draft-CheckCompliance',</span> <span class="pre">'Draft-Precheck',</span> <span class="pre">'Draft-Delete',</span> <span class="pre">'Draft-Apply']</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.OPERATIONS" title="Permalink to this definition"></a></dt>
<dd><p>Represents all audit enabled config manager operations. This class attribute
was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.PRE_CHECK">
<span class="sig-name descname"><span class="pre">PRE_CHECK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Precheck'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.PRE_CHECK" title="Permalink to this definition"></a></dt>
<dd><p>Represents Pre-check config manager operation
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters_client.Configuration.precheck()</span></code>. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.REMEDIATE">
<span class="sig-name descname"><span class="pre">REMEDIATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Remediate'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.REMEDIATE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Remediate config manager operation
<code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters_client.Configuration.apply()</span></code>. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.TRANSITION_ENABLE">
<span class="sig-name descname"><span class="pre">TRANSITION_ENABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Transition-Enable'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.OperationType.TRANSITION_ENABLE" title="Permalink to this definition"></a></dt>
<dd><p>Represents Transition enable config manager operation
com.vmware.esx.settings.clusters.enablement.. This class attribute was added in
vSphere API 8.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.TimePeriod">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TimePeriod</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</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">end</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.configuration_client.AuditRecords.TimePeriod" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AuditRecords.TimePeriod</span></code> class contains
<code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.TimePeriod.start</span></code> and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">AuditRecords.TimePeriod.end</span></code> to get audit records for a specific
time period. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>start</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – List of audit records that match the given start time i.e. occurred
after the DateTime start. This attribute was added in vSphere API
8.0.2.0.</p></li>
<li><p><strong>end</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – List of audit records that match the given end time i.e. occurred
before the DateTime end. This attribute was added in vSphere API
8.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filters</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.configuration_client.AuditRecords.list" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves audit information about the configuration actions performed
on the cluster. This method was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>filters</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditRecords.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – used to filter the audit records.
If None returns all available audit records associated with
<code class="docutils literal notranslate"><span class="pre">cluster</span></code></p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.list" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.AuditRecords.Info" title="com.vmware.esx.settings.clusters.configuration_client.AuditRecords.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuditRecords.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>audit Information about the cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
if the system is unable to communicate with a service to complete
the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the session id is missing from the request or the corresponding
session object cannot be found.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t not have the required privileges.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.View</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ClusterCompliance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster_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">commit</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">software_commit</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">summary</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">validation_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">host_info</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">hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compliant_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">non_compliant_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failed_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</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.configuration_client.ClusterCompliance" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">ClusterCompliance</span></code> class contains attributes that describe the
compliance result for each host in the cluster as well as overall cluster
compliance status. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster_status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status" title="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterCompliance.Status</span></code></a>) – Consolidated status of all host compliance checks. This attribute
was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This identifier refers to the commit action of importing the
desired configuration document. It will not be set for a draft
execution of check compliance. This attribute was added in vSphere
API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</span></code>.</p></li>
<li><p><strong>software_commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The current commit ID for the software associated with the cluster.
This attribute was added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</span></code>.</p></li>
<li><p><strong>summary</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Summarizing check compliance operation on the hosts in the cluster.
This attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>validation_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.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field represents the validation errors if the desired
configuration specified is not valid. This attribute was added in
vSphere API 8.0.3.0.
This field may be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ClusterCompliance.cluster_status</span></code> is NOT_COMPLIANT due to
validation errors.</p></li>
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <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>) – Map of host IDs to hostname. This attribute was added in vSphere
API 8.0.1.0.
When clients pass a value of this class as a parameter, the key in
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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 key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.HostResult" title="com.vmware.esx.settings.clusters.configuration_client.HostResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostResult</span></code></a>) – Map of host IDs to their compliance results. This attribute was
added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the key in
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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 key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>compliant_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of compliant hosts. This attribute was added in vSphere
API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>non_compliant_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of non-compliant hosts. This attribute was added in
vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>failed_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of hosts where the operation failed. This attribute was
added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>skipped_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifiers of hosts where the operation was skipped. i.e
disconnected hosts. This attribute was added in vSphere API
8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – CheckCompliance completion time. This attribute was added in
vSphere API 8.0.1.0.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>Consolidated compliance status of the cluster. This enumeration was added
in vSphere API 8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status.COMPLIANT">
<span class="sig-name descname"><span class="pre">COMPLIANT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status.COMPLIANT" title="Permalink to this definition"></a></dt>
<dd><p>All hosts in the cluster are compliant. This class attribute was added in
vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status.NOT_COMPLIANT">
<span class="sig-name descname"><span class="pre">NOT_COMPLIANT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='NOT_COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status.NOT_COMPLIANT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterCompliance.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The task is in-progress. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ClusterPrecheckResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</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">software_commit</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">end_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">summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remediation_summary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remediation_notes</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">validation_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">host_info</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_precheck</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">precheck_result</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">successful_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failed_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">PrecheckResult</span></code> class contains attributes that describe precheck
status of applying the desired document to a group of hosts. This class was
added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status" title="com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterPrecheckResult.Status</span></code></a>) – Overall status of precheck on the cluster. Operation is sucessfull
when precheck is run on all hosts successfully and no validation or
precheck errors are detected. This attribute was added in vSphere
API 8.0.1.0.</p></li>
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This identifier refers to the commit action of importing the
desired configuration document. This attribute was added in vSphere
API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</span></code>.
This field is s not set for a precheck of a draft configuration.</p></li>
<li><p><strong>software_commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The current commit ID for the software associated with the cluster.
This attribute was added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</span></code>.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Precheck completion time. This attribute was added in vSphere API
8.0.1.0.</p></li>
<li><p><strong>summary</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Summarizing precheck operation on the host and cluster. This
attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>remediation_summary</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Summarizing remediation stating number of hosts needing reboot and
maintenance mode during remediation and number of precheck errors
on host and cluster. This attribute was added in vSphere API
8.0.1.0.</p></li>
<li><p><strong>remediation_notes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Static notes to the user describing steps that will be taken during
remediation. This attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>validation_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.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field represents the validation errors if the desired
configuration specified is not valid. This attribute was added in
vSphere API 8.0.3.0.
This field is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if is ERROR due to validation errors.</p></li>
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <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>) – Map of host IDs to hostname. This attribute was added in vSphere
API 8.0.1.0.
When clients pass a value of this class as a parameter, the key in
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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 key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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_precheck</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.HostPrecheckResult" title="com.vmware.esx.settings.clusters.configuration_client.HostPrecheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostPrecheckResult</span></code></a>) – Map of host IDs to their precheck results. If
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ClusterPrecheckResult.status</span></code> is ERROR, This field will
contain Validation errors or Host Impact and Health Check errors.
If <code class="xref py py-attr docutils literal notranslate"><span class="pre">ClusterPrecheckResult.status</span></code> is OK, This field will
contain Impact and Health Check information. This attribute was
added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the key in
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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 key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>precheck_result</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.StatusInfo" title="com.vmware.esx.settings_client.StatusInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.StatusInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field represents the precheck results on the cluster, if any
one host in the cluster needs to be put in maintenance mode or to
be rebooted. This attribute was added in vSphere API 8.0.1.0.
This field is set if cluster prechecks are invoked.</p></li>
<li><p><strong>successful_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Hosts in this cluster where the precheck was sucessfully run. This
attribute was added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>failed_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Hosts in this cluster where the precheck failed to run. This
attribute was added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>skipped_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Hosts in this cluster where the precheck was not tried because the
host was disconnected. This attribute was added in vSphere API
8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterPrecheckResult.Status</span></code> class contains the possible statuses
of the Precheck API on the cluster. This enumeration was added in vSphere
API 8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>The operation failed with errors. This class attribute was added in vSphere
API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status.OK" title="Permalink to this definition"></a></dt>
<dd><p>The operation completed successfully. This class attribute was added in
vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ClusterPrecheckResult.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The task is in-progress. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ComplianceInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ComplianceInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sets</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">adds</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">deletes</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.configuration_client.ComplianceInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ComplianceInfo</span></code> class contains attributes that describe the
configuration drift between the desired document and the configurations on
the ESXi host. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sets</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.configuration_client.SettingCompliance" title="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SettingCompliance</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of configuration drifts represented by
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SettingCompliance" title="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SettingCompliance</span></code></a>. Each describing a configuration whose
value on ESXi host is different to that in the desired document.
This attribute was added in vSphere API 8.0.1.0.
This field is None if there are no drifts to report in this
category.</p></li>
<li><p><strong>adds</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.configuration_client.SettingCompliance" title="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SettingCompliance</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of configuration drifts represented by
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SettingCompliance" title="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SettingCompliance</span></code></a>. Each describing a configuration that is
present in the desired document but absent on the ESXi host. This
attribute was added in vSphere API 8.0.1.0.
This field is None if there are no drifts to report in this
category.</p></li>
<li><p><strong>deletes</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.configuration_client.SettingCompliance" title="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SettingCompliance</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of configuration drifts represented by
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SettingCompliance" title="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">SettingCompliance</span></code></a>. Each describing a configuration that is
present on the ESXi host but absent in the desired document. This
attribute was added in vSphere API 8.0.1.0.
This field is None if there are no drifts to report in this
category.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ComplianceStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">ComplianceStatus</span></code> class represents the compliance status of desired
configuration on the ESXi host. This enumeration was added in vSphere API
8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus.COMPLIANT">
<span class="sig-name descname"><span class="pre">COMPLIANT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ComplianceStatus(string='COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus.COMPLIANT" title="Permalink to this definition"></a></dt>
<dd><p>ESXi host is in compliance with Desired configuration. This class attribute
was added in vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus.NON_COMPLIANT">
<span class="sig-name descname"><span class="pre">NON_COMPLIANT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ComplianceStatus(string='NON_COMPLIANT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus.NON_COMPLIANT" title="Permalink to this definition"></a></dt>
<dd><p>ESXi host is not in compliance with Desired configuration. This class
attribute was added in vSphere API 8.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ConfigurationSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ConfigurationSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ConfigurationSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ConfigurationSpec</span></code> class contains attributes that describe the
desired configuration that is associated with a cluster. This class was
added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Desired configuration document. This attribute was added in vSphere
API 8.0.1.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DependencyError">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">DependencyError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">required_value</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">current_value</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">possible_values</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.configuration_client.DependencyError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DependencyError</span></code> class contains details of the validation error
caused by dependency between different properties in the configuration.
This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>required_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The dependency required by a union tag. This attribute was added in
vSphere API 8.0.2.0.</p></li>
<li><p><strong>current_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, it contains the current value of the dependency
property.</p></li>
<li><p><strong>possible_values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The possible values of the dependency property that are compatible
with this property. This attribute was added in vSphere API
8.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">DetailedValidationError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</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">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pattern</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">expected_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance_id</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">property_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum_length</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">minimum_length</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">maximum_value</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">minimum_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dependency_error</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">component</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">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</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">path</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">required_property</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.configuration_client.DetailedValidationError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SchemaValidationError</span></code> class contains details of validation errors
for a property. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If this error is from a host-level validation performed during a
precheck, the hosts that experienced this error will be added here.
This attribute was added in vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers 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 contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A user-friendly description of the error. This attribute was added
in vSphere API 8.0.2.0.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType"><code class="xref py py-class docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType</span></code></a>) – The type of error. Additional information may be set for some types
of errors. This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>pattern</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The pattern the property is required to match. This attribute was
added in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PATTERN_MISMATCH" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PATTERN_MISMATCH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.PATTERN_MISMATCH</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH</span></code></a>.</p></li>
<li><p><strong>expected_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The expected type of the property. This attribute was added in
vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_TYPE" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_TYPE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.INVALID_TYPE</span></code></a>.</p></li>
<li><p><strong>instance_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The instance ID that was duplicated or is missing from the profile
section. This attribute was added in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE</span></code></a>.</p></li>
<li><p><strong>property_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the property that holds the instance ID. This attribute
was added in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_INSTANCE_ID" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_INSTANCE_ID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MISSING_INSTANCE_ID</span></code></a>.</p></li>
<li><p><strong>maximum_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The maximum length allowed for a string or array property. This
attribute was added in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_STRING_LENGTH" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_STRING_LENGTH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MAX_STRING_LENGTH</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH</span></code></a>.</p></li>
<li><p><strong>minimum_length</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The minimum length allowed for a string or array property. This
attribute was added in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_STRING_LENGTH" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_STRING_LENGTH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MIN_STRING_LENGTH</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH</span></code></a>.</p></li>
<li><p><strong>maximum_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The maximum allowed value for a property. This attribute was added
in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_VALUE" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_VALUE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MAX_VALUE</span></code></a>.</p></li>
<li><p><strong>minimum_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The minimum allowed value for a property. This attribute was added
in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_VALUE" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_VALUE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MIN_VALUE</span></code></a>.</p></li>
<li><p><strong>dependency_error</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DependencyError" title="com.vmware.esx.settings.clusters.configuration_client.DependencyError"><code class="xref py py-class docutils literal notranslate"><span class="pre">DependencyError</span></code></a>) – The dependency required by a union tag. This attribute was added in
vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_UNION_TAG" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_UNION_TAG"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.INVALID_UNION_TAG</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG</span></code></a>.</p></li>
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – For <code class="docutils literal notranslate"><span class="pre">SCHEMA_NOT_FOUND</span></code> errors, this will be the component portion
of the unknown configuration. This attribute was added in vSphere
API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND</span></code></a>.</p></li>
<li><p><strong>group</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – For <code class="docutils literal notranslate"><span class="pre">SCHEMA_NOT_FOUND</span></code> errors, this will be the group portion of
the unknown configuration. This attribute was added in vSphere API
8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND</span></code></a>.</p></li>
<li><p><strong>key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – For <code class="docutils literal notranslate"><span class="pre">SCHEMA_NOT_FOUND</span></code> errors, this will be the key portion of
the unknown configuration. This attribute was added in vSphere API
8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND</span></code></a>.</p></li>
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The JSON-pointer to the configuration key in the profile section
where the instance/key needs to be added. This attribute was added
in vSphere API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE</span></code></a>
or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY</span></code></a>.</p></li>
<li><p><strong>required_property</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the required property that is missing from the profile
section for this instance/key. This attribute was added in vSphere
API 8.0.2.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is one of
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE</span></code></a>
or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ErrorType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DetailedValidationError.ErrorType</span></code> enum contains the possible types
of errors related to property validation. This enumeration was added in
vSphere API 8.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.ADDITIONAL_PROPERTY">
<span class="sig-name descname"><span class="pre">ADDITIONAL_PROPERTY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='ADDITIONAL_PROPERTY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.ADDITIONAL_PROPERTY" title="Permalink to this definition"></a></dt>
<dd><p>A property that is not specified in the schema was found. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID">
<span class="sig-name descname"><span class="pre">DUPLICATE_INSTANCE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='DUPLICATE_INSTANCE_ID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.DUPLICATE_INSTANCE_ID" title="Permalink to this definition"></a></dt>
<dd><p>An instance has an instance ID that was already used in another instance.
This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.EMPTY_PROPERTY">
<span class="sig-name descname"><span class="pre">EMPTY_PROPERTY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='EMPTY_PROPERTY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.EMPTY_PROPERTY" title="Permalink to this definition"></a></dt>
<dd><p>An object or array property is empty. This class attribute was added in
vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.GENERIC">
<span class="sig-name descname"><span class="pre">GENERIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='GENERIC')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.GENERIC" title="Permalink to this definition"></a></dt>
<dd><p>A generic error. Check the <code class="docutils literal notranslate"><span class="pre">message</span></code> property for more information. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.HOST_SPECIFIC_IN_PROFILE">
<span class="sig-name descname"><span class="pre">HOST_SPECIFIC_IN_PROFILE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='HOST_SPECIFIC_IN_PROFILE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.HOST_SPECIFIC_IN_PROFILE" title="Permalink to this definition"></a></dt>
<dd><p>The property is host-specific, but was found in the profile section. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.HOST_SPECIFIC_KEY_IN_OVERRIDE">
<span class="sig-name descname"><span class="pre">HOST_SPECIFIC_KEY_IN_OVERRIDE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='HOST_SPECIFIC_KEY_IN_OVERRIDE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.HOST_SPECIFIC_KEY_IN_OVERRIDE" title="Permalink to this definition"></a></dt>
<dd><p>A host-specific configuration was found in the host-override section. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_DELETE_DEFAULT">
<span class="sig-name descname"><span class="pre">INVALID_DELETE_DEFAULT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='INVALID_DELETE_DEFAULT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_DELETE_DEFAULT" title="Permalink to this definition"></a></dt>
<dd><p>The property is only valid for mutable default configurations. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_ENUM_OPTION">
<span class="sig-name descname"><span class="pre">INVALID_ENUM_OPTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='INVALID_ENUM_OPTION')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_ENUM_OPTION" title="Permalink to this definition"></a></dt>
<dd><p>The value of an enum property does not match one of the allowed values.
This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_TYPE">
<span class="sig-name descname"><span class="pre">INVALID_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='INVALID_TYPE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>The value of a property is not the expected type. This class attribute was
added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_UNION_TAG">
<span class="sig-name descname"><span class="pre">INVALID_UNION_TAG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='INVALID_UNION_TAG')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.INVALID_UNION_TAG" title="Permalink to this definition"></a></dt>
<dd><p>A property that is dependent on another property is invalid. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.KEY_IN_HOST_OVERRIDE">
<span class="sig-name descname"><span class="pre">KEY_IN_HOST_OVERRIDE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='KEY_IN_HOST_OVERRIDE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.KEY_IN_HOST_OVERRIDE" title="Permalink to this definition"></a></dt>
<dd><p>The configuration exists in both host-override and host-specific sections.
This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH">
<span class="sig-name descname"><span class="pre">MAX_ARRAY_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MAX_ARRAY_LENGTH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_ARRAY_LENGTH" title="Permalink to this definition"></a></dt>
<dd><p>The length of an array is larger than the maximum allowed. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_STRING_LENGTH">
<span class="sig-name descname"><span class="pre">MAX_STRING_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MAX_STRING_LENGTH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_STRING_LENGTH" title="Permalink to this definition"></a></dt>
<dd><p>The length of a string is larger than the maximum allowed. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_VALUE">
<span class="sig-name descname"><span class="pre">MAX_VALUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MAX_VALUE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MAX_VALUE" title="Permalink to this definition"></a></dt>
<dd><p>The value of a numeric property is larger than the maximum allowed. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH">
<span class="sig-name descname"><span class="pre">MIN_ARRAY_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MIN_ARRAY_LENGTH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_ARRAY_LENGTH" title="Permalink to this definition"></a></dt>
<dd><p>The length of an array is smaller than the minimum allowed. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_STRING_LENGTH">
<span class="sig-name descname"><span class="pre">MIN_STRING_LENGTH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MIN_STRING_LENGTH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_STRING_LENGTH" title="Permalink to this definition"></a></dt>
<dd><p>The length of a string is smaller than the minimum allowed. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_VALUE">
<span class="sig-name descname"><span class="pre">MIN_VALUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MIN_VALUE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MIN_VALUE" title="Permalink to this definition"></a></dt>
<dd><p>The value of a numeric property is smaller than the minimum allowed. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_INSTANCE_ID">
<span class="sig-name descname"><span class="pre">MISSING_INSTANCE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MISSING_INSTANCE_ID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_INSTANCE_ID" title="Permalink to this definition"></a></dt>
<dd><p>An instance does not have the required ID property. This class attribute
was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED">
<span class="sig-name descname"><span class="pre">MISSING_REQUIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MISSING_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>A required property is missing. This class attribute was added in vSphere
API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE">
<span class="sig-name descname"><span class="pre">MISSING_REQUIRED_PROFILE_INSTANCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MISSING_REQUIRED_PROFILE_INSTANCE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_INSTANCE" title="Permalink to this definition"></a></dt>
<dd><p>The host-specific configuration refers to an instance that does not exist
in the profile section. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY">
<span class="sig-name descname"><span class="pre">MISSING_REQUIRED_PROFILE_KEY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='MISSING_REQUIRED_PROFILE_KEY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.MISSING_REQUIRED_PROFILE_KEY" title="Permalink to this definition"></a></dt>
<dd><p>The host-specific configuration refers to a configuration key that does not
exist in the profile section. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.NOT_HOST_SPECIFIC">
<span class="sig-name descname"><span class="pre">NOT_HOST_SPECIFIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='NOT_HOST_SPECIFIC')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.NOT_HOST_SPECIFIC" title="Permalink to this definition"></a></dt>
<dd><p>The property is not host-specific, but was found in the host-specific
section. This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.NULL_VALUE">
<span class="sig-name descname"><span class="pre">NULL_VALUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='NULL_VALUE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.NULL_VALUE" title="Permalink to this definition"></a></dt>
<dd><p>A property has a null value. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PATTERN_MISMATCH">
<span class="sig-name descname"><span class="pre">PATTERN_MISMATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='PATTERN_MISMATCH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PATTERN_MISMATCH" title="Permalink to this definition"></a></dt>
<dd><p>The value of a string property does not match the allowed pattern. This
class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PLACEHOLDER_FOUND">
<span class="sig-name descname"><span class="pre">PLACEHOLDER_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='PLACEHOLDER_FOUND')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PLACEHOLDER_FOUND" title="Permalink to this definition"></a></dt>
<dd><p>The property contains a placeholder that must be replaced. This class
attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH">
<span class="sig-name descname"><span class="pre">PROPERTY_NAME_MISMATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='PROPERTY_NAME_MISMATCH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.PROPERTY_NAME_MISMATCH" title="Permalink to this definition"></a></dt>
<dd><p>A property name does not match the required pattern. This class attribute
was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND">
<span class="sig-name descname"><span class="pre">SCHEMA_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='SCHEMA_NOT_FOUND')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.SCHEMA_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd><p>A configuration was found for software that is not in the image associated
with the cluster. This class attribute was added in vSphere API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG">
<span class="sig-name descname"><span class="pre">UNION_CASE_WITHOUT_UNION_TAG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ErrorType(string='UNION_CASE_WITHOUT_UNION_TAG')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError.ErrorType.UNION_CASE_WITHOUT_UNION_TAG" title="Permalink to this definition"></a></dt>
<dd><p>A union-case property was provided, but the corresponding union tag
property was not set. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DocumentStructure">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">DocumentStructure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DocumentStructure" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DocumentStructure</span></code> class contains the possible structures of the
configuration document. This enumeration was added in vSphere API 8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DocumentStructure" title="com.vmware.esx.settings.clusters.configuration_client.DocumentStructure"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocumentStructure</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DocumentStructure.HOST_ORIENTED">
<span class="sig-name descname"><span class="pre">HOST_ORIENTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DocumentStructure(string='HOST_ORIENTED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DocumentStructure.HOST_ORIENTED" title="Permalink to this definition"></a></dt>
<dd><p>The host-specific portions of the document are stored in the
“host-specific” object at the top-level with entries for each host,
organized by the host’s BIOS UUID. This class attribute was added in
vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DocumentStructure.PROFILE_ORIENTED">
<span class="sig-name descname"><span class="pre">PROFILE_ORIENTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DocumentStructure(string='PROFILE_ORIENTED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DocumentStructure.PROFILE_ORIENTED" title="Permalink to this definition"></a></dt>
<dd><p>The host-specific portions of the document are distributed through the
“profile” object hierarchy. Each property that is host-specific will be an
object with entries for each host where the property is defined. The hosts
in the object are organized by BIOS UUID. This class attribute was added in
vSphere API 8.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">DraftImportResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</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">error</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">warnings</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.configuration_client.DraftImportResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DraftImportResult</span></code> class contains attributes that describe the
result of importing the desired configuration for a cluster into a draft.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status" title="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">DraftImportResult.Status</span></code></a>) – Status of importing desired configuration.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – This identifier refers to the commit action of importing the
desired configuration document. This identifier can be used in the
apply API.
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.esx.settings.draft</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.esx.settings.draft</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.configuration_client.DraftImportResult.Status.OK" title="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DraftImportResult.Status.OK</span></code></a>.</p></li>
<li><p><strong>error</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localized message describing the error encountered while importing
desired configuration. The import operation will fail if the
configuration document is an invalid JSON.
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.configuration_client.DraftImportResult.Status.ERROR" title="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DraftImportResult.Status.ERROR</span></code></a>.</p></li>
<li><p><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Any issues found during the import are reported in this list.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DraftImportResult.Status</span></code> class contains the possible status codes
describing the result of importing desired configuration for a cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.CANCELED">
<span class="sig-name descname"><span class="pre">CANCELED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='CANCELED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.CANCELED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Desired configuration import failed with error.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.OK" title="Permalink to this definition"></a></dt>
<dd><p>Desired configuration imported successfully.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.DraftImportResult.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The task is in-progress.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">Drafts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts</span></code> class provides methods to manage cluster configuration
drafts. This class was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplyResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ApplyResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">commit</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</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.configuration_client.Drafts.ApplyResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ApplyResult</span></code> class contains the result of committing a draft.
This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the commit created for this operation. This attribute was
added in vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</span></code>.</p></li>
<li><p><strong>apply_task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If the cluster is not empty, this will be set to the ID of the
Apply task. This attribute was added in vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplySpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ApplySpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</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_policy_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ApplySpec</span></code> class contains attributes that are used to create
a new commit. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Message to include with the commit. This attribute was added in
vSphere API 8.0.2.0.
If None, message is set to empty string.</p></li>
<li><p><strong>apply_policy_spec</strong> (<a class="reference internal" href="com.vmware.esx.settings.clusters.policies.html#com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec" title="com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.policies.apply_client.Effective.EffectivePolicySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The parameter can be used to override the default remediation
policies for the apply task. This attribute was added in vSphere
API 8.0.2.0.
if None the default cluster remediation policies are used.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangeDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ChangeDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">modified_properties</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">deleted_properties</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.configuration_client.Drafts.ChangeDetails" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ChangeDetails</span></code> class contains information about changes made
in the draft when compared against the current desired document. This class
was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>modified_properties</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ModificationInfo" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ModificationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ModificationInfo</span></code></a>) – Captures the properties that were added/modified in this draft. The
map keys are JSON-Pointers that refer to the properties in the
draft that are modifications. The values contain information about
the property and, in the case of a modification, the location of
the corresponding property in the desired document. This attribute
was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>deleted_properties</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.DeletionInfo" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.DeletionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.DeletionInfo</span></code></a>) – Captures the properties that were deleted from this draft. The map
keys are JSON-Pointers that refer to the properties in the desired
document that were deleted. This attribute was added in vSphere API
8.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangedProperty">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ChangedProperty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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">current</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">draft</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.configuration_client.Drafts.ChangedProperty" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ChangedProperty</span></code> class contains information about a property
that is different in this draft from the committed configuration. This
class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A JSON-Pointer that refers to the property that has been changed.
This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>current</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, the current value of the property in the cluster
configuration. If not set, the property does not exist in the
current cluster configuration.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, this is the new value for the property in this draft. If
not set, the property has been deleted in this draft.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangesResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ChangesResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sets</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">adds</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">deletes</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.configuration_client.Drafts.ChangesResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ChangesResult</span></code> class contains a detailed description of the
differences between this draft and the current desired configuration. This
class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sets</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.configuration_client.Drafts.ChangedProperty" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangedProperty"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ChangedProperty</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, this contains a list of properties that have been changed
from one value to another in this draft.</p></li>
<li><p><strong>adds</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.configuration_client.Drafts.ChangedProperty" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangedProperty"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ChangedProperty</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, this contains a list of properties that have been added in
this draft.</p></li>
<li><p><strong>deletes</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.configuration_client.Drafts.ChangedProperty" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangedProperty"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ChangedProperty</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, this contains a list of properties that have been deleted
in this draft.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ConflictDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConflictDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">properties</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.configuration_client.Drafts.ConflictDetails" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>properties</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ConflictPropertyInfo" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ConflictPropertyInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ConflictPropertyInfo</span></code></a>) – Map of properties in the current draft that were changed and
conflict with changes that were applied to the cluster
configuration document since this draft was created. This attribute
was added in vSphere API 8.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ConflictPropertyInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConflictPropertyInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">property_path</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.configuration_client.Drafts.ConflictPropertyInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ConflictPropertyInfo</span></code> class contains information about
conflicts that have been detected when attempting to merge configuration
changes that have been committed by other users. This class was added in
vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>property_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The path refers to the conflicting property in the cluster
configuration document. This attribute was added in vSphere API
8.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.CreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><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>, <em class="sig-param"><span class="n"><span class="pre">image_reference_host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.CreateSpec</span></code> class contains information used when creating a
draft. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The initial configuration for the draft. This attribute was added
in vSphere API 8.0.2.0.
If not specified, the current desired configuration for the cluster
will be used.</p></li>
<li><p><strong>image_reference_host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The host to use as the desired image for the cluster when VLCM is
not in use. This attribute was added in vSphere API 8.0.3.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
If not specified, the previously used reference host will be
carried over.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.DeletionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeletionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_path</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.configuration_client.Drafts.DeletionInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.DeletionInfo</span></code> class contains information about a property
that was deleted from the draft configuration. This class was added in
vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>display_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A list of the display names for components of the property path.
This attribute was added in vSphere API 8.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</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">changes</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">conflicts</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>, <em class="sig-param"><span class="n"><span class="pre">host_id_to_uuid</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.configuration_client.Drafts.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.Info</span></code> class defines the information about configuration
draft. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>metadata</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.Metadata" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Metadata</span></code></a>) – Metadata about the configuration draft. This attribute was added in
vSphere API 8.0.2.0.</p></li>
<li><p><strong>errors</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationDetails" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ValidationDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, there were validation errors detected in the draft
configuration.</p></li>
<li><p><strong>changes</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangeDetails" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangeDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ChangeDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, there are changes in this draft configuration from the
current desired configuration.</p></li>
<li><p><strong>conflicts</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ConflictDetails" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ConflictDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ConflictDetails</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, there are changes in this draft configuration that conflict
with changes applied by a different user.</p></li>
<li><p><strong>host_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <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>) – A mapping of BIOS UUIDs for every host in the cluster to
information about that host. The host-specific/host-override
sections of the configuration use BIOS UUIDs to identify hosts, so
this information can be useful to get details about hosts mentioned
there. This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>host_id_to_uuid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Map of host IDs to BIOS UUIDs. This attribute was added in vSphere
API 8.0.2.0.
When clients pass a value of this class as a parameter, the key in
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> 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 key in the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an
identifier for the resource type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
<li><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Configuration specification associated with the draft, encoded as
JSON. This attribute was added in vSphere API 8.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.Metadata">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</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">parent_id</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">owner</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">revision</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">creation_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">precheck_task</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">image_reference_host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.Metadata" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.Metadata</span></code> class defines the metadata information about
configuration draft. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The draft identifier. This attribute was added in vSphere API
8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</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.esx.settings.draft</span></code>.</p></li>
<li><p><strong>parent_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the parent commit. This attribute was added in
vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</span></code>.</p></li>
<li><p><strong>owner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Owner of the configuration draft. This attribute was added in
vSphere API 8.0.2.0.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.State" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.State</span></code></a>) – State of the configuration draft. This attribute was added in
vSphere API 8.0.2.0.</p></li>
<li><p><strong>revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The current revision of this draft. Any updates to the draft will
increment this value. This value should be included in calls to
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.update" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.update()</span></code></a> so that concurrent changes can be detected.
This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Creation time of the configuration draft. This attribute was added
in vSphere API 8.0.2.0.</p></li>
<li><p><strong>modified_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Last modified time of the configuration draft. This attribute was
added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>precheck_task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The ID of the precheck task that was last run for this draft. This
attribute was added in vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>. When methods return a value of this class
as a return value, the attribute will be an identifier for the
resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.
This field is None if precheck has not been done since the last
modification.</p></li>
<li><p><strong>image_reference_host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The ID of the host that is used as a reference for the cluster
image. This attribute was added in vSphere API 8.0.3.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
This field is None if the cluster is managed by VLCM.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ModificationInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ModificationInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_path</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">original_path</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.configuration_client.Drafts.ModificationInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ModificationInfo</span></code> class contains information about a
modification to a property in the configuration. This class was added in
vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A list of the display names for components of the property path.
This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>original_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This attribute was added in vSphere API 8.0.2.0.
If set, it contains a JSON-Pointer to the corresponding property in
the original document. Otherwise, this modification is an addition
to the draft.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.draft'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for draft resource. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.State">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">State</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The states of the draft configuration. This enumeration was added in
vSphere API 8.0.2.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.State.INVALID">
<span class="sig-name descname"><span class="pre">INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.State.INVALID" title="Permalink to this definition"></a></dt>
<dd><p>Configuration draft is invalid. This class attribute was added in vSphere
API 8.0.2.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.State.VALID">
<span class="sig-name descname"><span class="pre">VALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='VALID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.State.VALID" title="Permalink to this definition"></a></dt>
<dd><p>Configuration draft is valid. This class attribute was added in vSphere API
8.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.UpdateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpdateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expected_revision</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.configuration_client.Drafts.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.UpdateSpec</span></code> class contains the new configuration for the
draft. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>expected_revision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – When supplied, this revision value will be compared against the
draft’s current revision as returned in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.Metadata.revision</span></code> to ensure no other changes have
been applied. This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The new cluster configuration for this draft, encoded as JSON. This
attribute was added in vSphere API 8.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ValidationDetails</span></span><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationDetails" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ValidationDetails</span></code> class contains all validation errors
related to the draft configuration. This class was added in vSphere API
8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationErrors" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationErrors"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ValidationErrors</span></code></a>) – Map of JSON-Pointers to properties in the draft configuration that
have validation errors based on the schema and host-level
validations. This attribute was added in vSphere API 8.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationErrors">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ValidationErrors</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_path</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ValidationErrors" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ValidationErrors</span></code> class contains schema-based validation
errors for a given property. This class was added in vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A list of the display names for components of the property path.
This attribute was added in vSphere API 8.0.2.0.</p></li>
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError" title="com.vmware.esx.settings.clusters.configuration_client.DetailedValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">DetailedValidationError</span></code></a>) – Localized error message describing the validation error. This
attribute was added in vSphere API 8.0.2.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.apply">
<span class="sig-name descname"><span class="pre">apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.apply" title="Permalink to this definition"></a></dt>
<dd><p>Commit this draft and make it the new desired configuration for the
cluster. The draft must be in the <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.State.VALID" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.State.VALID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.State.VALID</span></code></a> state for
this method to succeed. A successful commit will result in the draft
being deleted. If the cluster is not empty, the Apply API will be
called with the new desired state. This method was added in vSphere API
8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplySpec" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ApplySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Additional arguments for the operation.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplyResult" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ApplyResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ApplyResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A structure that contains the ID of the new commit and, if an
ApplySpec was supplied, the ID of the Apply task.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 draft is not in the <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.State.VALID" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.State.VALID"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.State.VALID</span></code></a> state.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Remediate</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.Remediate</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.check_compliance_task">
<span class="sig-name descname"><span class="pre">check_compliance_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.check_compliance_task" title="Permalink to this definition"></a></dt>
<dd><p>Check all the hosts in the cluster for compliance with the
configuration specified in the draft. This method was added in vSphere
API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If an internal error occurred. The accompanying error message will
give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If API is called on a cluster that is not managed by desired
configuration management platform.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code></p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.TimedOut" title="com.vmware.vapi.std.errors_client.TimedOut"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.TimedOut</span></code></a>
If the API timed out before completion.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><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.configuration_client.Drafts.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a new draft with the given values. If a configuration is
supplied in the spec, it will be used as the initial value. Otherwise,
the current desired configuration will be used as the initial value.
The <code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.Metadata.owner</span></code> field will be set to the caller’s
user ID and the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.Metadata.parent_id</span></code> will be set to the
current commit ID for the cluster. This method was added in vSphere API
8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.CreateSpec" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.CreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Options used when creating the new draft.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
If there is already a draft by this author for this cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the supplied configuration is not valid JSON.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete this draft. Any changes will be abandoned. This method was added
in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.export_config">
<span class="sig-name descname"><span class="pre">export_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.export_config" title="Permalink to this definition"></a></dt>
<dd><p>This API will export the draft configuration associated with the
cluster. This method was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster 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></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ExportResult" title="com.vmware.esx.settings.clusters.configuration_client.ExportResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExportResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>This output structure of type
com.vmware.esx.settings.clusters.Configuration#ExportResult
contains the configuration document encoded as JSON.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some other unknown internal error. The accompanying
error message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Export</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Export</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.get" title="Permalink to this definition"></a></dt>
<dd><p>Get the cluster configuration and related metadata from this draft.
This method was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.Info" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.get_schema">
<span class="sig-name descname"><span class="pre">get_schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.get_schema" title="Permalink to this definition"></a></dt>
<dd><p>Returns the configuration schema associated with this draft. This
method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster 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></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>This output structure of type <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaResult</span></code></a> containing the
schema document encoded as JSON.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some other unknown internal error. The accompanying
error message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 or no draft associated
with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.import_from_host_task">
<span class="sig-name descname"><span class="pre">import_from_host_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</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.configuration_client.Drafts.import_from_host_task" title="Permalink to this definition"></a></dt>
<dd><p>The API imports the desired configuration from a reference host in the
cluster. The API also adds host-specific and host-overrides from the
other hosts in the cluster. Import API does not validate the
configuration against the schema. The result will specify if the
configuration was imported successfully. The result will provide
localized error message if the import operation failed. This method was
added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the reference host
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.list" title="Permalink to this definition"></a></dt>
<dd><p>Get the active drafts for this cluster. This method was added in
vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.Metadata" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Metadata</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of drafts keyed by their identifiers.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.View</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.precheck_task">
<span class="sig-name descname"><span class="pre">precheck_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.precheck_task" title="Permalink to this definition"></a></dt>
<dd><p>This API will perform impact analysis of the configuration specified in
the draft on each of the hosts in the cluster. The API will check
against the desired image schema whether the desired configuration has
added any requirements for the host to be put in maintenance mode or to
be rebooted. The API will also invoke plugins which will validate the
configuration on each hosts in the cluster. If the configuration is
valid the API will also detect if the host needs to be maintenance mode
or to be rebooted. If the hosts requires maintenance mode or reboot,
then the API will run health checks to see the hosts can be put into
the maintenance mode based on their current state. If any host cannot
be put into maintenance mode due to health errors, then those errors
will be reported in the result. The result will also list the
configurations that will change on applying the configuration in the
draft. This method was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster on which to perform impact analysis.
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>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.show_changes">
<span class="sig-name descname"><span class="pre">show_changes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.show_changes" title="Permalink to this definition"></a></dt>
<dd><p>Get the differences between this draft and the current desired state
for the cluster. This method was added in vSphere API 8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangesResult" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.ChangesResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ChangesResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Drafts.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</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.configuration_client.Drafts.update" title="Permalink to this definition"></a></dt>
<dd><p>Replace the current configuration in this draft with the supplied one.
If the supplied configuration is different from the current value, the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.Metadata.precheck_task</span></code> fields will be cleared. If an
expected revision number is provided, it must match the current
revision of this draft or a ConcurrentChange exception will be raised.
If no expected revision number is provided, this check will be skipped
and the update will go through. This method was added in vSphere API
8.0.2.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.Drafts.UpdateSpec" title="com.vmware.esx.settings.clusters.configuration_client.Drafts.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.UpdateSpec</span></code></a>) – </p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the supplied configuration is not valid JSON.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ConcurrentChange" title="com.vmware.vapi.std.errors_client.ConcurrentChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code></a>
If the expectedRevision in the <code class="docutils literal notranslate"><span class="pre">spec</span></code> differs from the draft’s
current revision.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.Modify</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ExportResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ExportResult</span></span><span class="sig-paren">(</span><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.configuration_client.ExportResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">ExportResult</span></code> class contains attributes that describe the result of
exporting configuration from the cluster. This class was added in vSphere
API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Configuration of the cluster encoded as JSON. This attribute was
added in vSphere API 8.0.1.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostCompliance">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">HostCompliance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compliance_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.configuration_client.HostCompliance" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostCompliance</span></code> class contains attributes that describe compliance
information for the ESXi host on which the Check Compliance operation
completed successfully. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus" title="com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceStatus</span></code></a>) – This field indicates whether the ESXi host is compliant with the
desired configuration specified in
com.vmware.esx.settings_daemon.Configuration#CheckComplianceSpec.
If COMPLIANT, no other information is available. If NON_COMPLAINT,
drift information can be fetched from {#ComplianceInfo}. This
attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>compliance_info</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceInfo" title="com.vmware.esx.settings.clusters.configuration_client.ComplianceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComplianceInfo</span></code></a>) – Settings compliance information generated by the CheckCompliance
operation. This attribute was added in vSphere API 8.0.1.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus.NON_COMPLIANT" title="com.vmware.esx.settings.clusters.configuration_client.ComplianceStatus.NON_COMPLIANT"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ComplianceStatus.NON_COMPLIANT</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostPrecheckResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">HostPrecheckResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</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">validation_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">impact</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">precheck_result</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.configuration_client.HostPrecheckResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">HostPrecheckResult</span></code> class contains attributes that describes the
Precheck API result on a host. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus" title="com.vmware.esx.settings.clusters.configuration_client.HostStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostStatus</span></code></a>) – This field represents the status of the precheck request for this
host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was
not completed on the host due to some error or if health checks
failed. If precheck failed due to host validation errors, details
are specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">HostPrecheckResult.validation_errors</span></code>. If
precheck failed due to generic error, details are specified in the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">HostPrecheckResult.summary</span></code>. Health check result is
specified in <code class="xref py py-attr docutils literal notranslate"><span class="pre">HostPrecheckResult.precheck_result</span></code>. This
attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>summary</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Summarizing precheck operation on the host. This attribute was
added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>validation_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.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field represents the validation errors if the desired
configuration specified is not valid. This attribute was added in
vSphere API 8.0.1.0.
This field is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if #HostStatus#status is ERROR due to
host returning validation errors.</p></li>
<li><p><strong>impact</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactInfo" title="com.vmware.esx.settings.clusters.configuration_client.ImpactInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImpactInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field represents the impact on the host to reach the desired
configuration state. This attribute was added in vSphere API
8.0.1.0.
This field is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there are no validation errors on the
host. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">HostStatus.status</span></code> may be OK or ERROR.</p></li>
<li><p><strong>precheck_result</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.StatusInfo" title="com.vmware.esx.settings_client.StatusInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.StatusInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field represents the health check results from the host, if
the host needs to be put in maintenance mode or to be rebooted.
This attribute was added in vSphere API 8.0.1.0.
This field is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> if there are not validation errors and
health checks are run on the host. The <code class="xref py py-attr docutils literal notranslate"><span class="pre">HostStatus.status</span></code>
may be OK or ERROR.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">HostResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host_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">summary</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">host_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.configuration_client.HostResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">HostResult</span></code> class contains attributes that describe the result of
the check compliance operation on an ESXi host. This class was added in
vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>host_status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus" title="com.vmware.esx.settings.clusters.configuration_client.HostStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostStatus</span></code></a>) – This field represents the status of the check compliance operation.
If status is OK, the result of operation can be retrived from
{#HostCompliance} {#Summary} field will summarize the status of the
operation and if applicable, the specific error that occured.
Additionally, {#ValidationError} is populated if the operation
fails due to host validation errors in desired document. This
attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>summary</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Summary of check compliance operation on the host. This attribute
was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – List of validation errors returned by the host. This is only set
for a specific HostStatus ERROR case. This attribute was added in
vSphere API 8.0.1.0.
This field is <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> only if the document fails to validate
on the host.</p></li>
<li><p><strong>host_compliance</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.HostCompliance" title="com.vmware.esx.settings.clusters.configuration_client.HostCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostCompliance</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – This field provides compliance results for the host if the
operation successfully completed on the host. That is, this field
is populated only if HostStatus is OK. This attribute was added in
vSphere API 8.0.1.0.
This field is None if check compliance could not be completed on
the host.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">HostStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attempts</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">remaining_retries</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">end_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">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.configuration_client.HostStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostStatus</span></code> class contains attributes that describe the status of an
method. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status" title="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">HostStatus.Status</span></code></a>) – The status of the method. This attribute was added in vSphere API
8.0.1.0.</p></li>
<li><p><strong>attempts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of the performed attempts of the method. This attribute was
added in vSphere API 8.0.1.0.
This field is None if it is not applicable.</p></li>
<li><p><strong>remaining_retries</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of the remaining attempts of the method. This attribute was
added in vSphere API 8.0.1.0.
This field is None if it is not applicable.</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method started. This attribute was added in vSphere
API 8.0.1.0.</p></li>
<li><p><strong>end_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Time when the method completed. This attribute was added in vSphere
API 8.0.1.0.</p></li>
<li><p><strong>notifications</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.Notifications" title="com.vmware.esx.settings_client.Notifications"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.Notifications</span></code></a>) – Notifications providing additional information about the status of
the method. This attribute was added in vSphere API 8.0.1.0.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HostStatus.Status</span></code> class contains the possible different status
codes that can be returned while trying to perform an operation on the
hosts within the cluster. This enumeration was added in vSphere API
8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.CANCELED">
<span class="sig-name descname"><span class="pre">CANCELED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='CANCELED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.CANCELED" title="Permalink to this definition"></a></dt>
<dd><p>The method was canceled. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>The method encountered an unspecified error. This class attribute was added
in vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.OK" title="Permalink to this definition"></a></dt>
<dd><p>The method completed successfully. This class attribute was added in
vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.PENDING">
<span class="sig-name descname"><span class="pre">PENDING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='PENDING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.PENDING" title="Permalink to this definition"></a></dt>
<dd><p>The method is pending. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.RETRY_PENDING">
<span class="sig-name descname"><span class="pre">RETRY_PENDING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RETRY_PENDING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.RETRY_PENDING" title="Permalink to this definition"></a></dt>
<dd><p>The method is pending a retry. This class attribute was added in vSphere
API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The method is in progress. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.SKIPPED">
<span class="sig-name descname"><span class="pre">SKIPPED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='SKIPPED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.SKIPPED" title="Permalink to this definition"></a></dt>
<dd><p>The method was skipped. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.TIMED_OUT">
<span class="sig-name descname"><span class="pre">TIMED_OUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='TIMED_OUT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.HostStatus.Status.TIMED_OUT" title="Permalink to this definition"></a></dt>
<dd><p>The method timed out. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImpactInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ImpactInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">impact</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">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.configuration_client.ImpactInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">ImpactInfo</span></code> class contains attributes that describes the Impact if
the host is not compliant against the desired configuration. This class was
added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>impact</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType" title="com.vmware.esx.settings.clusters.configuration_client.ImpactType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImpactType</span></code></a>) – This field indicates the ESXi host impact on applying the desired
configuration. This attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – This field represents the list of impact information describing the
configuration changes needed on the host to reach the desired
state. This attribute was added in vSphere API 8.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImpactType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ImpactType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImpactType</span></code> class contains information about the impact of applying
desired configuration on the ESXi host. This enumeration was added in
vSphere API 8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType" title="com.vmware.esx.settings.clusters.configuration_client.ImpactType"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImpactType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImpactType.MAINTENANCE_MODE_REQUIRED">
<span class="sig-name descname"><span class="pre">MAINTENANCE_MODE_REQUIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ImpactType(string='MAINTENANCE_MODE_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType.MAINTENANCE_MODE_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>Host requires maintenance mode to reach the desired state. This class
attribute was added in vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImpactType.NO_IMPACT">
<span class="sig-name descname"><span class="pre">NO_IMPACT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ImpactType(string='NO_IMPACT')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType.NO_IMPACT" title="Permalink to this definition"></a></dt>
<dd><p>Host has no impact. This class attribute was added in vSphere API 8.0.1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImpactType.REBOOT_REQUIRED">
<span class="sig-name descname"><span class="pre">REBOOT_REQUIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ImpactType(string='REBOOT_REQUIRED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImpactType.REBOOT_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>Host requires reboot to reach the desired state. This class attribute was
added in vSphere API 8.0.1.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImportResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ImportResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">ImportResult</span></code> class contains attributes that describe the result of
importing a configuration document in the cluster. This class was added in
vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status" title="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImportResult.Status</span></code></a>) – </p></li>
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – This identifier refers to the commit action of importing the
desired configuration document. This identifier can be used in the
apply API. This attribute was added in vSphere API 8.0.1.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</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.esx.settings.commit</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.configuration_client.ImportResult.Status.OK" title="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ImportResult.Status.OK</span></code></a>.</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.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationError</span></code></a>) – Lists all validation errors identified in the configuration
document. This attribute was added in vSphere API 8.0.1.0.
This is set when #success is false.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>This enum indicates whether the configuration document was imported
successfully in the cluster. This enumeration was added in vSphere API
8.0.1.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.CANCELED">
<span class="sig-name descname"><span class="pre">CANCELED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='CANCELED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.CANCELED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.ERROR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.OK" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ImportResult.Status.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The task is in-progress. This class attribute was added in vSphere API
8.0.1.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ReferenceHostInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">summary</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.configuration_client.ReferenceHostInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ReferenceHostInfo</span></code> class contains attributes that describe the host
that was used as a reference for generating the schema. This class was
added in vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status" title="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReferenceHostInfo.Status</span></code></a>) – The current status of the reference host. This attribute was added
in vSphere API 8.0.3.0.</p></li>
<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The ID of the reference host. This attribute was added in vSphere
API 8.0.3.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: <code class="docutils literal notranslate"><span class="pre">HostSystem</span></code>.
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.configuration_client.ReferenceHostInfo.Status.OK" title="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReferenceHostInfo.Status.OK</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.DISCONNECTED" title="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReferenceHostInfo.Status.DISCONNECTED</span></code></a>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the reference host. This attribute was added in vSphere
API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">status</span></code> is one of <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.OK" title="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.OK"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReferenceHostInfo.Status.OK</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.DISCONNECTED" title="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.DISCONNECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ReferenceHostInfo.Status.DISCONNECTED</span></code></a>.</p></li>
<li><p><strong>summary</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A summary of the reference host status. This attribute was added in
vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The status of the reference host. This enumeration was added in vSphere API
8.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.DISCONNECTED">
<span class="sig-name descname"><span class="pre">DISCONNECTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='DISCONNECTED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.DISCONNECTED" title="Permalink to this definition"></a></dt>
<dd><p>The reference host is in the cluster, but disconnected. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.OK">
<span class="sig-name descname"><span class="pre">OK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='OK')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.OK" title="Permalink to this definition"></a></dt>
<dd><p>The reference host is in the cluster and connected. This class attribute
was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.UNAVAILABLE">
<span class="sig-name descname"><span class="pre">UNAVAILABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='UNAVAILABLE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo.Status.UNAVAILABLE" title="Permalink to this definition"></a></dt>
<dd><p>There is no reference host or it is no longer in the cluster. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Schema">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">Schema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Schema" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Schema</span></code> class provides methods to manage the desired configuration
schema of an ESX cluster. This class was added in vSphere API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.Schema.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.Schema.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the configuration schema associated with the cluster. This
method was added in vSphere API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The schema associated with the <code class="docutils literal notranslate"><span class="pre">cluster</span></code></p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
In case of an unknown internal error.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If the <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is invalid</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If the schema associated with the <code class="docutils literal notranslate"><span class="pre">cluster</span></code> is not found</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is unavailable.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the session is unauthenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.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>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.SchemaResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">SchemaResult</span></span><span class="sig-paren">(</span><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">schema</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">reference_host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SchemaResult</span></code> class contains attributes that describe the
configuration schema associated with the cluster. This class was added in
vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaResult.Source</span></code></a>) – The source of this schema. This attribute was added in vSphere API
8.0.3.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
<li><p><strong>schema</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The configuration schema associated with the cluster. This
attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>reference_host</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo" title="com.vmware.esx.settings.clusters.configuration_client.ReferenceHostInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReferenceHostInfo</span></code></a>) – If the source of this schema was a reference, this field will be
populated with the current status of the host. This attribute was
added in vSphere API 8.0.3.0.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">source</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source.HOST" title="com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source.HOST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SchemaResult.Source.HOST</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Source</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The possible sources of the schema. This enumeration was added in vSphere
API 8.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Source</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source.HOST">
<span class="sig-name descname"><span class="pre">HOST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Source(string='HOST')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source.HOST" title="Permalink to this definition"></a></dt>
<dd><p>The schema was extracted from a reference host. This class attribute was
added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source.IMAGE_PROFILE">
<span class="sig-name descname"><span class="pre">IMAGE_PROFILE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Source(string='IMAGE_PROFILE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.SchemaResult.Source.IMAGE_PROFILE" title="Permalink to this definition"></a></dt>
<dd><p>The schema was derived from a VLCM image profile. This class attribute was
added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.SettingCompliance">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">SettingCompliance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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">current</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">target</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.configuration_client.SettingCompliance" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SettingCompliance</span></code> class contains attributes that describe a drift
in an ESXi host setting. This structure is used to describe either a change
in configuration value(set) or addition of configuration or deletion of
configuration. When used to describe addition or deletion of a setting,
only the path is set. When used to describe a set operation, current and
target values are set only if drift is in a property that is of primitive
type. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Full path to the setting within the desired document. This
attribute was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>current</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value of setting on the ESXi host. This attribute was added in
vSphere API 8.0.1.0.
This field is None if there is no host value to report or if
setting is of complex type.</p></li>
<li><p><strong>target</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Value of setting in the desired document. This attribute was added
in vSphere API 8.0.1.0.
This field is None if there is no value in the desired document to
report or if setting is of complex type.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ValidationError">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ValidationError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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">messages</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.configuration_client.ValidationError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ValidationError</span></code> class contains attributes that describes a
validation error in the configuration. This class was added in vSphere API
8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Full path to the configuration or the property within the
configuration which was found to be invalid. This attribute was
added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localized error message describing the validation error. This
attribute was added in vSphere API 8.0.1.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.configuration_client.ValidationResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.configuration_client.</span></span><span class="sig-name descname"><span class="pre">ValidationResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">valid</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.configuration_client.ValidationResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This <code class="docutils literal notranslate"><span class="pre">ValidationResult</span></code> class contains attributes that describe the
result of validating a configuration document. This class was added in
vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>valid</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – This boolean flag indicates whether the configuration document
validated successfully with no validation errors. This attribute
was added in vSphere API 8.0.1.0.</p></li>
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.configuration_client.ValidationError" title="com.vmware.esx.settings.clusters.configuration_client.ValidationError"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValidationError</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Lists all validation errors identified in the configuration
document. This attribute was added in vSphere API 8.0.1.0.
This is set when <code class="xref py py-attr docutils literal notranslate"><span class="pre">ValidationResult.valid</span></code> is false.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.esx.settings.clusters.enablement_client">
<span id="com-vmware-esx-settings-clusters-enablement-client-module"></span><h2>com.vmware.esx.settings.clusters.enablement_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.enablement_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.enablement_client</span></code> module provides
classes to manage enablement of the feature that allows to collectively manage
hosts within the cluster with a single software specification.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Configuration">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.enablement_client.</span></span><span class="sig-name descname"><span class="pre">Configuration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Configuration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Configuration</span></code> class provides methods to control whether the cluster
is managed using desired configuration platform semantics. This class was
added in vSphere API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Configuration.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Configuration.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Configuration.Info</span></code> class contains information describing whether
the feature is enabled. This class was added in vSphere API 8.0.1.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Status of the feature enablement True if feature is enabled, false
otherwise. This attribute was added in vSphere API 8.0.1.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Configuration.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Configuration.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether the given cluster is managed using a desired
configuration plaftorm. This method was added in vSphere API 8.0.1.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Configuration.Info" title="com.vmware.esx.settings.clusters.enablement_client.Configuration.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Configuration.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the feature enablement.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.View</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.ClusterConfiguration.View</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.enablement_client.</span></span><span class="sig-name descname"><span class="pre">Software</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Software</span></code> class provides methods to control whether the cluster is
managed with a single software specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckResult</span></span><span class="sig-paren">(</span><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_client.Software.CheckResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckResult</span></code> class contains information that describes the
results of the checks.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>notifications</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckType</span></code></a> and <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>) – Notifications containing check results grouped by
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckType</span></code></a> type.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checks_to_skip</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_client.Software.CheckSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckSpec</span></code> class contains information describing what
checks should be performed.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>checks_to_skip</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckType</span></code></a>) – Specifies the checks that should be skipped. If the <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> is
empty, all checks will be performed.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CheckType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Software.CheckType</span></code> class contains various checks to identify the
possibility to enable the feature that manages the cluster with a single
software specification.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">CheckType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE">
<span class="sig-name descname"><span class="pre">SOFTWARE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CheckType(string='SOFTWARE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE" title="Permalink to this definition"></a></dt>
<dd><p>Perform host software check. This check is to report standalone VIBs (VIBs
which are not part of any component) and the features on the given cluster
that cannot coexist with the feature which manages the cluster with a
single software specification.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE_SPECIFICATION_EXISTENCE">
<span class="sig-name descname"><span class="pre">SOFTWARE_SPECIFICATION_EXISTENCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CheckType(string='SOFTWARE_SPECIFICATION_EXISTENCE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE_SPECIFICATION_EXISTENCE" title="Permalink to this definition"></a></dt>
<dd><p>Perform cluster’s software specification existence check.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.STATELESSNESS">
<span class="sig-name descname"><span class="pre">STATELESSNESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CheckType(string='STATELESSNESS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.STATELESSNESS" title="Permalink to this definition"></a></dt>
<dd><p>Perform host statelessness check. This feature does not support stateless
hosts.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VERSION">
<span class="sig-name descname"><span class="pre">VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CheckType(string='VERSION')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VERSION" title="Permalink to this definition"></a></dt>
<dd><p>Perform host version check. This feature does not support hosts with
version less than XYZ.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VSAN_WITNESS_ELIGIBILITY">
<span class="sig-name descname"><span class="pre">VSAN_WITNESS_ELIGIBILITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CheckType(string='VSAN_WITNESS_ELIGIBILITY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VSAN_WITNESS_ELIGIBILITY" title="Permalink to this definition"></a></dt>
<dd><p>Checks to verify if the cluster software specification can be used to
manage any vSAN witness hosts in the cluster. This class attribute was
added in vSphere API 7.0.2.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VUM_REMEDIATION">
<span class="sig-name descname"><span class="pre">VUM_REMEDIATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CheckType(string='VUM_REMEDIATION')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.VUM_REMEDIATION" title="Permalink to this definition"></a></dt>
<dd><p>Perform VUM active remediation check.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.EnableSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EnableSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">skip_software_check</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_client.Software.EnableSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Software.EnableSpec</span></code> class contains information describing checks
that should be skipped during enablement. Currently only
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.CheckType.SOFTWARE</span></code></a> check can be skipped.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>skip_software_check</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Skip <a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckType.SOFTWARE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Software.CheckType.SOFTWARE</span></code></a> check during feature
enablement.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Software.Info</span></code> class contains information describing whether the
feature is enabled.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Status of the feature enablement True if feature is enabled, false
otherwise</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.check_task">
<span class="sig-name descname"><span class="pre">check_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.check_task" title="Permalink to this definition"></a></dt>
<dd><p>Checks the possibility to manage the cluster with a single software
specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckSpec" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Check specification.
If None, all checks are performed.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown error. The accompanying error message will
give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
If the feature is already enabled for the given cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.enable_task">
<span class="sig-name descname"><span class="pre">enable_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.enable_task" title="Permalink to this definition"></a></dt>
<dd><p>Enables the feature which manages the cluster with a single software
specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.EnableSpec" title="com.vmware.esx.settings.clusters.enablement_client.Software.EnableSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.EnableSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enablement specification.
If None, all checks are performed.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If feature enablement failed for the given cluster. The value of
the data attribute of
<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> will be a class
that contains all the attributes defined in
<a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.CheckResult" title="com.vmware.esx.settings.clusters.enablement_client.Software.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.CheckResult</span></code></a>.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
If the feature is already enabled for the given cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.Software.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.Software.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether the given cluster is managed with a single software
specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.enablement_client.Software.Info" title="com.vmware.esx.settings.clusters.enablement_client.Software.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Software.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the feature enablement.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.enablement_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.enablement_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.enablement_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.esx.settings.clusters.policies_client">
<span id="com-vmware-esx-settings-clusters-policies-client-module"></span><h2>com.vmware.esx.settings.clusters.policies_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.policies_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.policies_client</span></code> module provides
classes to manage policies that affect management of desired state
configuration and software for an ESXi cluster. Copyright 2019-2023 VMware,
Inc. All rights reserved. VMware Confidential Copyright 2020-2021, 2023 VMware,
Inc. All rights reserved. VMware Confidential Copyright 2023 VMware, Inc. All
rights reserved. VMware Confidential</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies_client.</span></span><span class="sig-name descname"><span class="pre">Apply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Apply</span></code> class provides methods to configure the policies that will
impact how the software and configuration specification documents are
applied to an ESXi cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConfiguredPolicySpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pre_remediation_power_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enable_quick_boot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_dpm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_hac</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">evacuate_offline_vms</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_hcl_validation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parallel_remediation_action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforce_quick_patch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config_manager_policy_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec</span></code> class contains attributes that describe
the policies configured to be used when the software and configuration
specification documents are applied to an ESXi cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>failure_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction" title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.FailureAction</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – What action is to be taken if entering maintenance mode fails on a
given host of the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>pre_remediation_power_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction" title="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec.PreRemediationPowerAction</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies what should be done to the power state of the VM before
entering maintenance mode.
If None, configured value would be unset.</p></li>
<li><p><strong>enable_quick_boot</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable Quick Boot during remediation in the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>disable_dpm</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disable DPM on the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>disable_hac</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Disable HA Admission control on the cluster.
If None, configured value would be unset.</p></li>
<li><p><strong>evacuate_offline_vms</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Evacuate powered off/suspended VMs when attempting maintenance
mode.
If None, configured value would be unset.</p></li>
<li><p><strong>enforce_hcl_validation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enforce Hcl validation, when applicable, to prevent remediation if
hardware compatibility issues are found. This attribute was added
in vSphere API 7.0.1.0.
If None, hardware compatibility issues will not prevent
remediation.</p></li>
<li><p><strong>parallel_remediation_action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ParallelRemediationAction" title="com.vmware.esx.settings.clusters.policies_client.Apply.ParallelRemediationAction"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ParallelRemediationAction</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enable parallel remediation of hosts in maintenance mode. Set max
hosts when applicable. This attribute was added in vSphere API
8.0.0.1.
If None, parallel remediation will not happen.</p></li>
<li><p><strong>enforce_quick_patch</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Enforce quick patch on the cluster for images that support it. This
attribute was added in vSphere API 8.0.3.0.
If None, configured value would be unset.</p></li>
<li><p><strong>config_manager_policy_spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec" title="com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigManagerPolicySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Configure settings applicable to the
com.vmware.esx.settings.clusters.Configuration.apply API. This
attribute was added in vSphere API 8.0.3.0.
If None, configured values will be unset.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PreRemediationPowerAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec.PreRemediationPowerAction</span></code> class defines
the possible actions to be taken, before entering maintenance mode.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">PreRemediationPowerAction</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE">
<span class="sig-name descname"><span class="pre">DO_NOT_CHANGE_VMS_POWER_STATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='DO_NOT_CHANGE_VMS_POWER_STATE')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.DO_NOT_CHANGE_VMS_POWER_STATE" title="Permalink to this definition"></a></dt>
<dd><p>Do not change the VM power state</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.POWER_OFF_VMS">
<span class="sig-name descname"><span class="pre">POWER_OFF_VMS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='POWER_OFF_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.POWER_OFF_VMS" title="Permalink to this definition"></a></dt>
<dd><p>Power off VMs before entering maintenance mode.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS">
<span class="sig-name descname"><span class="pre">SUSPEND_VMS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS" title="Permalink to this definition"></a></dt>
<dd><p>Suspend VMs before entering maintenance mode</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY">
<span class="sig-name descname"><span class="pre">SUSPEND_VMS_TO_MEMORY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">PreRemediationPowerAction(string='SUSPEND_VMS_TO_MEMORY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec.PreRemediationPowerAction.SUSPEND_VMS_TO_MEMORY" title="Permalink to this definition"></a></dt>
<dd><p>Suspend VMs to Memory before entering maintenance mode. This class
attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FailureAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retry_count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.FailureAction</span></code> class contains attributes that describe the
actions to be taken when entering maintenance mode fails on a single host
within the cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>action</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action" title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.FailureAction.Action</span></code></a>) – What action (FAIL, RETRY) is to be taken if entering maintenance
mode fails on a single host within the cluster.</p></li>
<li><p><strong>retry_delay</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Time to wait to retry the failed operation in seconds.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY" title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.Action.RETRY</span></code></a>.</p></li>
<li><p><strong>retry_count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Number of times to retry the failed operation.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">action</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY" title="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.Action.RETRY</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Apply.FailureAction.Action</span></code> class defines the actions to be taken
when entering maintenance mode fails on a single host within the cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Action</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.FAIL">
<span class="sig-name descname"><span class="pre">FAIL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Action(string='FAIL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.FAIL" title="Permalink to this definition"></a></dt>
<dd><p>Fail the apply method</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY">
<span class="sig-name descname"><span class="pre">RETRY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Action(string='RETRY')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.FailureAction.Action.RETRY" title="Permalink to this definition"></a></dt>
<dd><p>Retry the task <code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.retry_count</span></code> number of times on
the failed host after <code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.FailureAction.retry_delay</span></code>.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.ParallelRemediationAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ParallelRemediationAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_hosts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ParallelRemediationAction" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>enabled</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Enable parallel remediation for hosts in maintenance mode within a
cluster. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>max_hosts</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Maximum number of hosts that can be remediated in parallel. Setting
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Apply.ParallelRemediationAction.max_hosts</span></code> does not
guarantee maxHosts to be remediated in parallel. This attribute was
added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the configured policy that has been set for the cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec" title="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The configured policies that impact the apply method</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is an unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.Apply.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.Apply.set" title="Permalink to this definition"></a></dt>
<dd><p>This API will set the configured policy specification for the cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The cluster identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec" title="com.vmware.esx.settings.clusters.policies_client.Apply.ConfiguredPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Apply.ConfiguredPolicySpec</span></code></a>) – The policy that needs to be configured.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is an unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If invalid value is provided.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSettings.Write</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies_client.</span></span><span class="sig-name descname"><span class="pre">ConfigManagerPolicySpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">serial_remediation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This specification defines the settings to manage the
com.vmware.esx.settings.clusters.Configuration.apply API behaviour. This
class was added in vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>serial_remediation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specifies whether the hosts in the cluster should be serially
remediated. This attribute was added in vSphere API 8.0.3.0.
If None, configured values will be unset.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpecResetInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies_client.</span></span><span class="sig-name descname"><span class="pre">ConfigManagerPolicySpecResetInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">from_</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">to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpecResetInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>Describes the outcome when the settings that govern the
com.vmware.esx.settings.clusters.Configuration.apply API behaviour are
reset. This class was added in vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>from</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec" title="com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigManagerPolicySpec</span></code></a>) – The configured values of the
com.vmware.esx.settings.clusters.policies.Apply.ConfigManagerPolicySpec.
This attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>to</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec" title="com.vmware.esx.settings.clusters.policies_client.ConfigManagerPolicySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigManagerPolicySpec</span></code></a>) – The values of the
com.vmware.esx.settings.clusters.policies.Apply.ConfigManagerPolicySpec
for when the configured value is reset. This attribute was added in
vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.policies_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.policies_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.policies_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.esx.settings.clusters.software_client">
<span id="com-vmware-esx-settings-clusters-software-client-module"></span><h2>com.vmware.esx.settings.clusters.software_client module<a class="headerlink" href="#module-com.vmware.esx.settings.clusters.software_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.clusters.software_client</span></code> module provides
classes to manage desired state software for ESX cluster.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.AddOn">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">AddOn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.AddOn" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">AddOn</span></code> class provides methods to manage desired OEM add-on
specification for a given cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.AddOn.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.add_on'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.AddOn.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for add-on resource</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.AddOn.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.AddOn.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the desired OEM add-on specification for a given cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.AddOnInfo" title="com.vmware.esx.settings_client.AddOnInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.AddOnInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Desired OEM add-on specification.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
if desired OEM add-on specification is not found.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.BaseImage">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">BaseImage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.BaseImage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">BaseImage</span></code> class provides methods to manage desired ESX base image.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.BaseImage.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.base_image'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.BaseImage.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for base-image resource</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.BaseImage.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.BaseImage.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the desired base-image specification set for given cluster</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.BaseImageInfo" title="com.vmware.esx.settings_client.BaseImageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.BaseImageInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Base-image specification.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
if desired specification is not found.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">Commits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Commits" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Commits</span></code> class provides methods to manage committed changes to
desired software document.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">commit_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">description</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_status</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.software_client.Commits.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Commits.Info</span></code> class defines the information about software draft.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>author</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Author of the commit.</p></li>
<li><p><strong>commit_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Creation time of the commit.</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Description accompanying this commit.</p></li>
<li><p><strong>apply_status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType" title="com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Commits.Info.ApplyStatusType</span></code></a>) – Apply status of the commit.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ApplyStatusType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Commits.Info.ApplyStatusType</span></code> class defines possible values
regarding the application of this commit.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ApplyStatusType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType.APPLIED">
<span class="sig-name descname"><span class="pre">APPLIED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplyStatusType(string='APPLIED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType.APPLIED" title="Permalink to this definition"></a></dt>
<dd><p>Commit has been applied to the cluster.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType.NOT_APPLIED">
<span class="sig-name descname"><span class="pre">NOT_APPLIED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ApplyStatusType(string='NOT_APPLIED')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Commits.Info.ApplyStatusType.NOT_APPLIED" title="Permalink to this definition"></a></dt>
<dd><p>Commit hasn’t been applied to the cluster.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.commit'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Commits.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for commit resource</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Commits.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">commit</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Commits.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the information about a specific commit.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>commit</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the specific commit.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.commit</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Commits.Info" title="com.vmware.esx.settings.clusters.software_client.Commits.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Commits.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the commit.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
if desired specification commit is not found.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Compliance">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">Compliance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Compliance" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Compliance</span></code> class provides methods to get the last software
compliance result for an ESX cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Compliance.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ClusterComputeResource'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Compliance.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for cluster resource</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Compliance.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Compliance.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the compliance state for the cluster</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ClusterCompliance" title="com.vmware.esx.settings_client.ClusterCompliance"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ClusterCompliance</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Cluster compliance result.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
if the compliance information is unavailable.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Components">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">Components</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Components" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Components</span></code> class provides methods to get desired component
specification for an ESX cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Components.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.component'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Components.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for component resource</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Components.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Components.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the component version for the given component in the desired
software specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Details about the component version.
If None then version is supposed to be chosen based on the
constraints in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If invalid component name is provided.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
or no component associated with <code class="docutils literal notranslate"><span class="pre">component</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Components.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Components.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of components in the desired software specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of ComponentInfo keyed by the component identifier. If no
version is specified in desired software specification, then
ComponentInfo will not be present for that component.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">Drafts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts</span></code> class provides methods to manage working copy of software
documents.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.CommitSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommitSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</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.software_client.Drafts.CommitSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.CommitSpec</span></code> class contains attributes that are used to create
a new commit.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Message to include with the commit.
If None, message is set to empty string.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owners</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.software_client.Drafts.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.FilterSpec</span></code> class contains attributes used to filter the
results when listing software drafts. See <a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.list" title="com.vmware.esx.settings.clusters.software_client.Drafts.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Drafts.list()</span></code></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>owners</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Owners of the drafts.
If None or empty, drafts from all owners will be returned.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.ImportSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ImportSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</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">file_id</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">software_spec</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.ImportSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ImportSpec</span></code> class defines the information used to import the
desired software specification.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>source_type</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType" title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.SourceType</span></code></a>) – Type of the source to import the desired software specification</p></li>
<li><p><strong>location</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Location of the software specification file to be imported.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PULL" title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PULL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.SourceType.PULL</span></code></a>.</p></li>
<li><p><strong>file_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – File identifier returned by the file upload endpoint after file is
uploaded.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PUSH" title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PUSH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.SourceType.PUSH</span></code></a>.</p></li>
<li><p><strong>software_spec</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The JSON string representing the desired software specification.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">sourceType</span></code> is <a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.JSON_STRING" title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.JSON_STRING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.SourceType.JSON_STRING</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</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">software</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.software_client.Drafts.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.Info</span></code> class defines the information about software draft.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>metadata</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.Metadata" title="com.vmware.esx.settings.clusters.software_client.Drafts.Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Metadata</span></code></a>) – Metadata about the software draft.</p></li>
<li><p><strong>software</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo" title="com.vmware.esx.settings_client.SoftwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a>) – Software specification associated with the draft.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.Metadata">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">owner</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">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">creation_time</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.software_client.Drafts.Metadata" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.Metadata</span></code> class defines the metadata information about
software draft.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>owner</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Owner of the software draft.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType" title="com.vmware.esx.settings.clusters.software_client.Drafts.StatusType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.StatusType</span></code></a>) – Status of the software draft.</p></li>
<li><p><strong>creation_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Creation time of the software draft.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.draft'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for draft resource</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SourceType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.SourceType</span></code> class defines possible values of sources to
import software specification.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION">
<span class="sig-name descname"><span class="pre">CURRENT_SERIES_RECOMMENDATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SourceType(string='CURRENT_SERIES_RECOMMENDATION')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.JSON_STRING">
<span class="sig-name descname"><span class="pre">JSON_STRING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SourceType(string='JSON_STRING')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.JSON_STRING" title="Permalink to this definition"></a></dt>
<dd><p>The string representing the content of the software specfication.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION">
<span class="sig-name descname"><span class="pre">LATEST_RECOMMENDATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SourceType(string='LATEST_RECOMMENDATION')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PULL">
<span class="sig-name descname"><span class="pre">PULL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SourceType(string='PULL')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PULL" title="Permalink to this definition"></a></dt>
<dd><p>Content is pulled from the URL location. The URL scheme of the value in
{\&#64;link #pullLocation) can be http, https or file.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PUSH">
<span class="sig-name descname"><span class="pre">PUSH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SourceType(string='PUSH')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.PUSH" title="Permalink to this definition"></a></dt>
<dd><p>Content was previously uploaded using the file upload enpoint present on
vCenter appliance. This endpoint is present at
<a class="reference external" href="https://VCENTERFQDN:9087/vum-fileupload">https://VCENTERFQDN:9087/vum-fileupload</a> URL.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.SPECIFIED_BASE_IMAGE_RECOMMENDATION">
<span class="sig-name descname"><span class="pre">SPECIFIED_BASE_IMAGE_RECOMMENDATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SourceType(string='SPECIFIED_BASE_IMAGE_RECOMMENDATION')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.SPECIFIED_BASE_IMAGE_RECOMMENDATION" title="Permalink to this definition"></a></dt>
<dd><p>This class attribute was added in vSphere API 7.0.2.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.StatusType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StatusType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.StatusType</span></code> class defines possible values of status of a
software draft.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">StatusType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.StatusType.INVALID">
<span class="sig-name descname"><span class="pre">INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">StatusType(string='INVALID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType.INVALID" title="Permalink to this definition"></a></dt>
<dd><p>Software draft is invalid.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.StatusType.VALID">
<span class="sig-name descname"><span class="pre">VALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">StatusType(string='VALID')</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.StatusType.VALID" title="Permalink to this definition"></a></dt>
<dd><p>Software draft is valid.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</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.software_client.Drafts.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.Summary</span></code> class defines the summary information about software
draft.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>metadata</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.Metadata" title="com.vmware.esx.settings.clusters.software_client.Drafts.Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Metadata</span></code></a>) – Metadata about the software draft.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.ValidateResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ValidateResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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.software_client.Drafts.ValidateResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Drafts.ValidateResult</span></code> class contains attributes to describe result
of validation of desired software specification.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>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>) – Notifications associated with the validation.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.commit_task">
<span class="sig-name descname"><span class="pre">commit_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</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.software_client.Drafts.commit_task" title="Permalink to this definition"></a></dt>
<dd><p>Commits the specified draft as the desired state document. The result
of this operation can be queried by calling the cis/tasks/{task-id}
where the task-id is the response of this operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the draft.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.CommitSpec" title="com.vmware.esx.settings.clusters.software_client.Drafts.CommitSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.CommitSpec</span></code></a>) – The spec to be used to create the commit.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 there is another operation in progress.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If validation of the software document fails. The value of the data
attribute of <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> will
be a class that contains all the attributes defined in
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.ValidateResult" title="com.vmware.esx.settings.clusters.software_client.Drafts.ValidateResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ValidateResult</span></code></a>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new software draft from the desired document. It will be
deleted, when the draft is committed successfully. If a desired
document is missing, then this method will create an empty draft.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Identifier of the working copy of the document.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
If there is already a draft created by this user.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</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.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the software draft.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Write</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.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the information about given software draft.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the software draft.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.Info" title="com.vmware.esx.settings.clusters.software_client.Drafts.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the Software Draft.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.import_software_spec">
<span class="sig-name descname"><span class="pre">import_software_spec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.import_software_spec" title="Permalink to this definition"></a></dt>
<dd><p>Imports the desired software specification as a new draft. If a desired
document is missing, then this method will create an empty draft except
when the source type is of either
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION" title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.LATEST_RECOMMENDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.SourceType.LATEST_RECOMMENDATION</span></code></a> or
<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION" title="com.vmware.esx.settings.clusters.software_client.Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Drafts.SourceType.CURRENT_SERIES_RECOMMENDATION</span></code></a>, then
<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> error is reported.
In addition, the exisiting draft will be overwritten when the source
type is of either <code class="docutils literal notranslate"><span class="pre">LATEST_RECOMMENDATION</span></code> or
<code class="docutils literal notranslate"><span class="pre">CURRENT_SERIES_RECOMMENDATION</span></code>.</p>
<p><strong>Warning:</strong> Using HTTP is not secure. Please use HTTPS URLs instead.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.ImportSpec" title="com.vmware.esx.settings.clusters.software_client.Drafts.ImportSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.ImportSpec</span></code></a>) – Specification to import desired software specification.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Identifier of the software draft.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 or
if the source type of import specification is of either
<code class="docutils literal notranslate"><span class="pre">LATEST_RECOMMENDATION</span></code> or <code class="docutils literal notranslate"><span class="pre">CURRENT_SERIES_RECOMMENDATION</span></code>, and
a recommendation does not exist for the cluster. It was either
never generated or deleted due to changes in cluster state such as
a new desired image spec being committed.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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.lifecycleSoftwareSpecification.Write</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.lifecycleSoftwareSpecification.Write</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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.software_client.Drafts.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about the software drafts for the specified cluster
that match the <a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec" title="com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.FilterSpec</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec" title="com.vmware.esx.settings.clusters.software_client.Drafts.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter to be applied while returning drafts.
If None, all drafts will be returned.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Drafts.Summary" title="com.vmware.esx.settings.clusters.software_client.Drafts.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Drafts.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of software drafts keyed by their identifiers.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.scan_task">
<span class="sig-name descname"><span class="pre">scan_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.scan_task" title="Permalink to this definition"></a></dt>
<dd><p>Scans all the hosts in the cluster against the software draft. The
result of this operation can be queried by calling the
cis/tasks/{task-id} where the task-id is the response of this
operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the working copy of the document.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Drafts.validate_task">
<span class="sig-name descname"><span class="pre">validate_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">draft</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Drafts.validate_task" title="Permalink to this definition"></a></dt>
<dd><p>Validates the software draft. The result of this operation can be
queried by calling the cis/tasks/{task-id} where the task-id is the
response of this operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>draft</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the software draft.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.draft</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no draft
associated with <code class="docutils literal notranslate"><span class="pre">draft</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.EffectiveComponents">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">EffectiveComponents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.EffectiveComponents" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">EffectiveComponents</span></code> class provides methods to get effective list of
components.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.EffectiveComponents.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.EffectiveComponents.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns the effective components for the cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.EffectiveComponentInfo" title="com.vmware.esx.settings_client.EffectiveComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.EffectiveComponentInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of effective components keyed by their identifier.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.EffectiveComponents.list_with_removed_components">
<span class="sig-name descname"><span class="pre">list_with_removed_components</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.EffectiveComponents.list_with_removed_components" title="Permalink to this definition"></a></dt>
<dd><p>Returns the list of all the effective components. Pass the param
“with-removed-components” to get even the removed components. This
method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.EffectiveComponentInfo" title="com.vmware.esx.settings_client.EffectiveComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.EffectiveComponentInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of effective components keyed by their identifier.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 such cluster <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the caller does not have the required privileges.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
If the cluster is not vLCM managed.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.HardwareSupport">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">HardwareSupport</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.HardwareSupport" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">HardwareSupport</span></code> class provides methods to manage a cluster’s
Hardware Support Package (HSP) configuration.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.HardwareSupport.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.HardwareSupport.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns a given cluster’s Hardware Support Package (HSP) configuration.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.HardwareSupportInfo" title="com.vmware.esx.settings_client.HardwareSupportInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.HardwareSupportInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Hardware Support Package (HSP) selected for use</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster named <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no Hardware Support
Package (HSP) configured in the cluster’s desired state document.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Recommendations">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">Recommendations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Recommendations" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Recommendations</span></code> class provides methods to manage the generation and
retrieval of recommended image specs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Recommendations.ExplanationDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ExplanationDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">display_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display_version</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">explanation</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.software_client.Recommendations.ExplanationDetails" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Recommendations.ExplanationDetails</span></code> class contains attributes to
describe the result of validation of desired software specification.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display name of an excluded image entity (base image, add-on etc.).</p></li>
<li><p><strong>display_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Display version of an excluded image entity (base image, add-on
etc.).</p></li>
<li><p><strong>explanation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – List of explanations on why the image entity is excluded.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Recommendations.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base_image_version</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.software_client.Recommendations.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Recommendations.FilterSpec</span></code> class contains attributes used to filter
the generated recommendations (see <code class="xref py py-func docutils literal notranslate"><span class="pre">Recommendations.generate()</span></code>) based
on a specified base image version. This class was added in vSphere API
7.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>base_image_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Base image version string is used in generating the specified base
image recommendations. Default recommendations are generated when
the value is empty. This attribute was added in vSphere API
7.0.2.0.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Recommendations.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">latest_recommendation</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">current_series_recommendation</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">specified_base_image_version_recommendation</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">base_image_explanation_details</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">check_time</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.software_client.Recommendations.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Recommendations.Info</span></code> class defines the information about the most
recent recommendation generation result.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>latest_recommendation</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo" title="com.vmware.esx.settings_client.SoftwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recommended image specification based on latest base image version.
None if no recommended image based on latest base image version is
available.</p></li>
<li><p><strong>current_series_recommendation</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo" title="com.vmware.esx.settings_client.SoftwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recommended image specification based on latest base image patch or
update of the current series.
None if no recommended image based on latest base image patch or
update of the current series is available.</p></li>
<li><p><strong>specified_base_image_version_recommendation</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SoftwareInfo" title="com.vmware.esx.settings_client.SoftwareInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SoftwareInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Recommended image specification based on a specified base image
version. This attribute was added in vSphere API 7.0.2.0.
None if no recommendation image based on the specified base image
version is available.</p></li>
<li><p><strong>base_image_explanation_details</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.software_client.Recommendations.ExplanationDetails" title="com.vmware.esx.settings.clusters.software_client.Recommendations.ExplanationDetails"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recommendations.ExplanationDetails</span></code></a>) – Details about why some base images are excluded in latest and
current series recommendations. This is not applicable for
specified base image recommendations.</p></li>
<li><p><strong>check_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The most recent timestamp when check for recommended image is
launched.
None if no recommendation check has ever been launched.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Recommendations.generate_task">
<span class="sig-name descname"><span class="pre">generate_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter</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.software_client.Recommendations.generate_task" title="Permalink to this definition"></a></dt>
<dd><p>Generates recommended software image spec(s) based on current desired
software spec. The result of this operation can be queried by calling
the cis/tasks/{task-id} where the task-id is the response of this
operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Recommendations.FilterSpec" title="com.vmware.esx.settings.clusters.software_client.Recommendations.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recommendations.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Specification on how to filter recommendations based on a specified
base image version. This parameter was added in vSphere API
7.0.2.0.
If None, latest and current series recommendations are generated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ConcurrentChange" title="com.vmware.vapi.std.errors_client.ConcurrentChange"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ConcurrentChange</span></code></a>
If a new desired image is committed in parallel via a different
client while recommendation is being generated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Recommendations.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Recommendations.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns Information about the most recent recommendation generation
result.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.esx.settings.clusters.software_client.Recommendations.Info" title="com.vmware.esx.settings.clusters.software_client.Recommendations.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Recommendations.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the most recent recommendation generation result.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
recommendation is non-existing for the cluster due to either it is
never generated or deleted due to changes in cluster state such as
a new desired image spec being committed.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.RemovedComponents">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">RemovedComponents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.RemovedComponents" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">RemovedComponents</span></code> class provides methods to manage removal of
components in a software specification. This class was added in vSphere API
8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.RemovedComponents.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.component'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.RemovedComponents.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for component resource. This class attribute was added in vSphere
API 8.0.3.0.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.RemovedComponents.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">component</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.RemovedComponents.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns the component info for the given removed component in the
desired software specification. This method was added in vSphere API
8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>component</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Details about the component.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
or no component associated with <code class="docutils literal notranslate"><span class="pre">component</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the caller does not have the required privileges.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
If the cluster is not vLCM managed.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.RemovedComponents.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.RemovedComponents.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns a map of removed components in the desired software
specification. This method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.ComponentInfo" title="com.vmware.esx.settings_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.ComponentInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of ComponentInfo keyed by the component identifier. If no
version is specified in desired software specification, then it
will be empty.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.component</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is some unknown internal error. The accompanying error
message will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
If the caller does not have the required privileges.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
If the cluster is not vLCM managed.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Solutions">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">Solutions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Solutions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Solutions</span></code> class provides methods to manage desired software
solution specifications for an ESX cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Solutions.RESOURCE_TYPE">
<span class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'com.vmware.esx.settings.solution'</span></em><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Solutions.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for solution resource</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Solutions.delete_task">
<span class="sig-name descname"><span class="pre">delete_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">solution</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Solutions.delete_task" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the given solution from the desired software specification. The
deletion will be validated along with the entire software specification
before it is committed as new desired spec. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the
task-id is the response of this operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>solution</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the solution.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.solution</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if validation of the software document fails. The value of the data
attribute of <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> will
be a class that contains all the attributes defined in
ValidateResult.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no solution
associated with <code class="docutils literal notranslate"><span class="pre">solution</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Solutions.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">solution</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Solutions.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns components registered for the given solution in the desired
software specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>solution</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the solution.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.solution</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SolutionInfo" title="com.vmware.esx.settings_client.SolutionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SolutionInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Specification of components registered by the solution.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
If invalid component name is provided.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system or
or no solution associated with <code class="docutils literal notranslate"><span class="pre">solution</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Solutions.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.Solutions.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns all solutions in the desired software specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SolutionInfo" title="com.vmware.esx.settings_client.SolutionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SolutionInfo</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Map of solutions where key is solution identifier and value is a
list of components registered by that solution.
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.solution</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> in the system.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
If the caller is not authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code> referenced by the
parameter <code class="docutils literal notranslate"><span class="pre">cluster</span></code> requires
<code class="docutils literal notranslate"><span class="pre">VcIntegrity.lifecycleSoftwareSpecification.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.Solutions.set_task">
<span class="sig-name descname"><span class="pre">set_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">solution</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.software_client.Solutions.set_task" title="Permalink to this definition"></a></dt>
<dd><p>Sets the components registered for the given solution in the desired
software specification. The task will set only one solution
specification at a time. Solution constraints would be validated with
the current desired software specification before it is committed as
new desired spec. The result of this operation can be queried by
calling the cis/tasks/{task-id} where the task-id is the response of
this operation.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>solution</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the solution.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.esx.settings.solution</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="com.vmware.esx.html#com.vmware.esx.settings_client.SolutionSpec" title="com.vmware.esx.settings_client.SolutionSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.esx.settings_client.SolutionSpec</span></code></a>) – Registered solution specification.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>vmware.vapi.stdlib.client.task.Task</cite></p>
</dd>
</dl>
</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Task instance</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
If there is unknown internal error. The accompanying error message
will give more details about the failure.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if validation of the software document fails. The value of the data
attribute of <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> will
be a class that contains all the attributes defined in
ValidateResult.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
If there is no cluster associated with <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or no solution
associated with <code class="docutils literal notranslate"><span class="pre">solution</span></code> in the system.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ServiceUnavailable" title="com.vmware.vapi.std.errors_client.ServiceUnavailable"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ServiceUnavailable</span></code></a>
If the service is not available.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the caller is not authenticated.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.esx.settings.clusters.software_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.esx.settings.clusters.software_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.esx.settings.clusters.software_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.esx.settings.html" class="btn btn-neutral float-left" title="com.vmware.esx.settings package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.esx.settings.clusters.configuration.html" class="btn btn-neutral float-right" title="com.vmware.esx.settings.clusters.configuration package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink