Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-25 10:50:00 -05:00
Code
8ed6ef5a71
vsphere-automation-sdk-python/vsphere/7.0.3.0/com.vmware.vcenter.namespace_management.html
Shweta 4b77198d0f
703 api reference docs (#289) 
Signed-off-by: shweta <spurohit@vmware.com>
2021-10-13 19:14:42 +05:30

2135 lines
197 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.namespace_management package &mdash; vSphere Automation SDK for Python. 7.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.namespaces package" href="com.vmware.vcenter.namespaces.html" />
<link rel="prev" title="com.vmware.vcenter.lcm package" href="com.vmware.vcenter.lcm.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">
7.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" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li>com.vmware.vcenter.namespace_management package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.namespace_management.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vcenter.namespace_management">
<span id="com-vmware-vcenter-namespace-management-package"></span><h1>com.vmware.vcenter.namespace_management package<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vcenter.namespace_management.cns_client">
<span id="com-vmware-vcenter-namespace-management-cns-client-module"></span><h2>com.vmware.vcenter.namespace_management.cns_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.cns_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.cns_client</span></code> module provides
classes for configuration of PSP capabilities on VC clusters.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.cns_client.</span></code><code class="sig-name descname"><span class="pre">MaintenanceActionType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">MaintenanceActionType</span></code> class contains actions to be taken when an
entity enters maintenance mode.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType" title="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType"><code class="xref py py-class docutils literal notranslate"><span class="pre">MaintenanceActionType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.EnsureAccessibility">
<code class="sig-name descname"><span class="pre">EnsureAccessibility</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceActionType(string='EnsureAccessibility')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.EnsureAccessibility" title="Permalink to this definition"></a></dt>
<dd><p>The entity is going down temporarily for maintenance. Still need to ensure
application availability and storage accessibility at least in a degraded
level.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.NoAction">
<code class="sig-name descname"><span class="pre">NoAction</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceActionType(string='NoAction')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.NoAction" title="Permalink to this definition"></a></dt>
<dd><p>Admin override to not delay or stop the entity from entering maintenance
mode.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.PermanentRemoval">
<code class="sig-name descname"><span class="pre">PermanentRemoval</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MaintenanceActionType(string='PermanentRemoval')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.PermanentRemoval" title="Permalink to this definition"></a></dt>
<dd><p>The entity is getting permanently removed. Move applications, rebuild
storage on other entities before allowing to proceed.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.cns_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.cns_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.cns_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.namespace_management.software_client">
<span id="com-vmware-vcenter-namespace-management-software-client-module"></span><h2>com.vmware.vcenter.namespace_management.software_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.software_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.software_client</span></code> module provides
classes for managing namespaces software components.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.software_client.</span></code><code class="sig-name descname"><span class="pre">Clusters</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters</span></code> class provides methods to upgrade the vSphere clusters.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_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">available_versions</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">last_upgraded_date</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>, <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">upgrade_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.vcenter.namespace_management.software_client.Clusters.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Info</span></code> class contains detailed information about the cluster
upgrade status and related information.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>current_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current version of the cluster.</p></li>
<li><p><strong>available_versions</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>) – Set of available versions can be upgraded to.</p></li>
<li><p><strong>last_upgraded_date</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>) – Date of last successful upgrade.
If None, the cluster has not yet been upgraded.</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.vcenter.namespace_management.software_client.Clusters.Message" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the cluster version.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State" title="com.vmware.vcenter.namespace_management.software_client.Clusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.State</span></code></a>) – Current state of the upgrade.</p></li>
<li><p><strong>upgrade_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about upgrade in progress.
If None, the cluster upgrade is not in progress.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Message</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">severity</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">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.vcenter.namespace_management.software_client.Clusters.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Message</span></code> class contains the information about the object
configuration.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message.Severity</span></code></a>) – Type of the message.</p></li>
<li><p><strong>details</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>) – Details about the message.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Severity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Message.Severity</span></code> class represents the severity of the
message.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Severity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Severity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.INFO">
<code class="sig-name descname"><span class="pre">INFO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Severity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.INFO" title="Permalink to this definition"></a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Severity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Result</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">res</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">exception</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.vcenter.namespace_management.software_client.Clusters.Result" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Result</span></code> class contains the result of batch upgrade method.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>res</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Result.Res</span></code></a>) – The result of batch upgrade method.</p></li>
<li><p><strong>exception</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code>) – Exception when cluster pre-check failed during upgrade invocation.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">res</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Result.Res.REJECTED</span></code></a>.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Res</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Result.Res</span></code> class represents the upgrade invocation result
for each cluster.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Res</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED">
<code class="sig-name descname"><span class="pre">REJECTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Res(string='REJECTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade is rejected. This implies pre-check failed when invoking upgrade of
the cluster.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.STARTED">
<code class="sig-name descname"><span class="pre">STARTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">Res(string='STARTED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.STARTED" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade is started.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.State</span></code> class describes the state of the upgrade.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade failed and need user intervention.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.PENDING">
<code class="sig-name descname"><span class="pre">PENDING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='PENDING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.PENDING" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade is in progress.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.READY">
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.READY" title="Permalink to this definition"></a></dt>
<dd><p>Cluster is ready when there is no upgrade or upgrade is completed.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</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">cluster_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">current_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">available_versions</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">last_upgraded_date</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">desired_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">state</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.vcenter.namespace_management.software_client.Clusters.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Summary</span></code> class contains basic information about the cluster
upgrade related information.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
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>cluster_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the cluster.
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.name</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.name</span></code>.</p></li>
<li><p><strong>current_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current version of the cluster.</p></li>
<li><p><strong>available_versions</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>) – Set of versions available for upgrade.</p></li>
<li><p><strong>last_upgraded_date</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>) – Date of last successful upgrade.
If None, the cluster has not yet been upgraded.</p></li>
<li><p><strong>desired_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>) – Desired version the cluster will be upgraded to.
If None, the cluster upgrade is not in progress.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State" title="com.vmware.vcenter.namespace_management.software_client.Clusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.State</span></code></a>) – Current state of the upgrade.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradeProgress</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">total</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">completed</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpgradeProgress</span></code> class contains detailed information about
the cluster upgrade progess.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>total</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total amount of the work for the operation. The work here
represents the number of master nodes in the cluster need to be
upgraded.</p></li>
<li><p><strong>completed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The amount of work completed for the operation. The value can only
be incremented. The number or master nodes which upgrade completed.</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>) – Message about the work progress.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradeSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">desired_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">ignore_precheck_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.vcenter.namespace_management.software_client.Clusters.UpgradeSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpgradeSpec</span></code> class contains the specification required to
upgrade a cluster.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>desired_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version number the cluster is going to be upgraded to.</p></li>
<li><p><strong>ignore_precheck_warnings</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>) – If true, the upgrade workflow will ignore any pre-check warnings
and proceed with the upgrade.
If None, the upgrade workflow will not ignore pre-check warnings
and fail the upgrade. It is equivalent to setting the value to
false. The workflow adopts a conservative approach of failing the
upgrade if None to solely let the user decide whether to force the
upgrade despite the warnings.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">UpgradeStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">desired_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">messages</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">progress</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.vcenter.namespace_management.software_client.Clusters.UpgradeStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpgradeStatus</span></code> class contains detailed information about
the cluster when upgraded is in progress.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>desired_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>) – Desired version the cluster will be upgraded to.
If None, the cluster upgrade is not in progress.</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.vcenter.namespace_management.software_client.Clusters.Message" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the upgrade state.</p></li>
<li><p><strong>progress</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeProgress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about upgrade progess.
If None, the cluster upgrade is not in progress.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns upgrade related information of a specific cluster.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster which will be upgraded.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Info" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the upgrade of the specified WCP enabled cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 cluster could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 WCP enabled.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns upgrade related information about all WCP enabled clusters.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.list" title="com.vmware.vcenter.namespace_management.software_client.Clusters.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.vcenter.namespace_management.software_client.Clusters.Summary" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Summary</span></code></a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of upgrade summary of all WCP enabled clusters.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade">
<code class="sig-name descname"><span class="pre">upgrade</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade the cluster to a specific version. This operation upgrades the
components on control plane VMs and worker plane hosts based on the
selected version. Before upgrading, this operation performs pre-checks
and sets the evaluation response in Info.UpgradeStatus.messages with
various Message.Severity levels. Depending on the severity, the upgrade
may or may not proceed beyond prechecks. Here is a list of severities
and corresponding behavior: - ERROR: Upgrade does not proceed beyond
precheck operation - WARNING: Upgrade proceeds beyond precheck
operation only if UpgradeSpec.ignorePrecheckWarnings is set to true -
INFO: Upgrade proceeds beyond precheck operation uninterrupted</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster which will be upgraded.
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.vcenter.namespace_management.software_client.Clusters.UpgradeSpec" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeSpec</span></code></a>) – Specification for upgrading the cluster.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 pre-check failed of the cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 cluster could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Upgrade privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade_multiple">
<code class="sig-name descname"><span class="pre">upgrade_multiple</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">specs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade_multiple" title="Permalink to this definition"></a></dt>
<dd><p>Upgrade a set of clusters to its corresponding specific version.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>specs</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.vcenter.namespace_management.software_client.Clusters.UpgradeSpec" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeSpec</span></code></a>) – Specifications for upgrading selected clusters.
The key in the parameter <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">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</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.vcenter.namespace_management.software_client.Clusters.Result" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Result</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Pre-check result when invoking upgrade for each cluster.
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">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Upgrade privilege on all
specified clusters.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.software_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.software_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.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">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.namespace_management.stats_client">
<span id="com-vmware-vcenter-namespace-management-stats-client-module"></span><h2>com.vmware.vcenter.namespace_management.stats_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.stats_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.stats_client</span></code> module provides
classes for gathering statistics related to various Namespaces related
components.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.stats_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.stats_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.stats_client.</span></code><code class="sig-name descname"><span class="pre">TimeSeries</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">TimeSeries</span></code> class provides methods to gather statistical values for
clusters, namespaces and pods.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">PodIdentifier</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</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">pod_name</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.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Pod identifier. These are the fields required to uniquely identify a pod.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The namespace that the pod is running in.
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.vcenter.namespaces.Instance</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.vcenter.namespaces.Instance</span></code>.</p></li>
<li><p><strong>pod_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the pod itself.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Spec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj_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">pod</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">namespace</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">cluster</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</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.vcenter.namespace_management.stats_client.TimeSeries.Spec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>This structure is sent in a request for TimeSeries data and is used to
specify what object stats should be returned for.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>obj_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType</span></code></a>) – Type of statistics object that the request is operating on.</p></li>
<li><p><strong>pod</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.PodIdentifier</span></code></a>) – Pod Identifier for queries on an individual pod.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">objType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType.POD</span></code></a>.</p></li>
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Namespace name for queries for a namespace.
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.vcenter.namespaces.Instance</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.vcenter.namespaces.Instance</span></code>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">objType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType.NAMESPACE</span></code></a>.</p></li>
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Cluster identifier for queries for a cluster.
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>.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">objType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType.CLUSTER</span></code></a>.</p></li>
<li><p><strong>start</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – UNIX timestamp value indicating when the requested series of
statistical samples should begin.
<a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">https://en.wikipedia.org/wiki/Unix_time</a></p></li>
<li><p><strong>end</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – UNIX timestamp value indicating when the requested series of
statistical samples should end.
<a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">https://en.wikipedia.org/wiki/Unix_time</a></p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ObjType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>Type of statistics object that this request is operating on.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ObjType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER">
<code class="sig-name descname"><span class="pre">CLUSTER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjType(string='CLUSTER')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER" title="Permalink to this definition"></a></dt>
<dd><p>The CLUSTER object type is used when specifying a vSphere cluster.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE">
<code class="sig-name descname"><span class="pre">NAMESPACE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjType(string='NAMESPACE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE" title="Permalink to this definition"></a></dt>
<dd><p>The NAMESPACE object type is used to specify a namespace.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD">
<code class="sig-name descname"><span class="pre">POD</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ObjType(string='POD')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD" title="Permalink to this definition"></a></dt>
<dd><p>The POD object type is used to specify an individual pod within a
namespace.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">TimeSeries</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">counter</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_stamps</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">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.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A set of timestamps and statistical values representing a time series. The
lengths of <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.TimeSeries.time_stamps</span></code> and
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.TimeSeries.values</span></code> will always match each other.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>counter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter identifier.</p></li>
<li><p><strong>time_stamps</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">long</span></code>) – Sequence of UNIX timestamp values at which statistical values were
sampled. <a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">https://en.wikipedia.org/wiki/Unix_time</a></p></li>
<li><p><strong>values</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">long</span></code>) – Sequence of sampled values corresponding to the timestamps in tss.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.get" title="Permalink to this definition"></a></dt>
<dd><p>Gather statistical values for a cluster, namespace, or pod.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.Spec</span></code></a>) – Specification of the statistical values that should be returned.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.TimeSeries</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A list of TimeSeries values for each counter specified in the
request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 start time in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.start</span></code> is invalid, or
the end time in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.end</span></code> is invalid.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified cluster in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.cluster</span></code> or the
namespace in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.namespace</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.pod</span></code> does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 specified cluster in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.cluster</span></code> is not
enabled for Namespaces.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-com.vmware.vcenter.namespace_management.supervisor_services_client">
<span id="com-vmware-vcenter-namespace-management-supervisor-services-client-module"></span><h2>com.vmware.vcenter.namespace_management.supervisor_services_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisor_services_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client</span></code>
module provides classes for managing supervisor services that are extensions to
the vSphere Supervisor clusters.</p>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.</span></code><code class="sig-name descname"><span class="pre">ClusterSupervisorServices</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices</span></code> class provides methods to manage a
Supervisor Service on the vSphere Supervisor clusters. This class was added
in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ConfigStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.ConfigStatus</span></code> class describes the status
of reaching the desired state configuration for the Supervisor Service.
This enumeration was added in vSphere API 7.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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.CONFIGURED">
<code class="sig-name descname"><span class="pre">CONFIGURED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='CONFIGURED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.CONFIGURED" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor Service has been configured correctly (i.e. the provided
YAML content has been applied successfully to the cluster). This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.CONFIGURING">
<code class="sig-name descname"><span class="pre">CONFIGURING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='CONFIGURING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.CONFIGURING" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor Service is being installed. This class attribute was added
in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Failed to install the Supervisor Service, user intervention needed. This
class attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.REMOVING">
<code class="sig-name descname"><span class="pre">REMOVING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ConfigStatus(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor Service is being deleted. This class attribute was added in
vSphere API 7.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</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">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">service_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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.CreateSpec</span></code> class provides a specification
required to create a Supervisor Service on a vSphere Supervisor cluster.
This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service. This Supervisor Service must
be in the <code class="docutils literal notranslate"><span class="pre">State#ACTIVATED</span></code> state. This attribute was added in
vSphere API 7.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">com.vmware.vcenter.namespace_management.SupervisorService</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.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service version which contains the
service definition. This Supervisor Service version must be in the
<code class="docutils literal notranslate"><span class="pre">State#ACTIVATED</span></code> state. This attribute was added in vSphere API
7.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">com.vmware.vcenter.namespace_management.supervisor_services.Version</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.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
<li><p><strong>service_config</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>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A generic key-value map for additional configuration parameters
required during service creation. As an example, a third party
operator might reference a private registry using parameters such
as “registryName” for the registry name, “registryUsername” and
“registryPassword” for the registry credentials. This attribute was
added in vSphere API 7.0.3.0.
If None, no additional configuration parameters will be applied
when installing a Supervisor Service in the vSphere Supervisor
cluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">desired_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">service_namespace</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_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">messages</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_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">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">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">prefix</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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Info</span></code> class contains the detailed
information about a Supervisor Service on the vSphere Supervisor cluster.
This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>desired_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The desired version of this Supervisor Service. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>service_namespace</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>) – Identifier of the namespace to allocate the Supervisor Service’s
operators. This attribute was added in vSphere API 7.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">com.vmware.vcenter.namespaces.Instance</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.vcenter.namespaces.Instance</span></code>.
If None, there is an error when creating the service namespace or
the namespace has not been created yet.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.ConfigStatus</span></code></a>) – Current setting for <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.ConfigStatus</span></code>.
This attribute was added in vSphere API 7.0.3.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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Message</span></code></a>) – Current set of messages associated with the Supervisor Service on
the vSphere Supervisor cluster. This attribute was added in vSphere
API 7.0.3.0.</p></li>
<li><p><strong>current_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>) – The current version for the Supervisor Service. This attribute was
added in vSphere API 7.0.3.0.
If None, there is no version installed for the Supervisor Service.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A human readable name of the Supervisor Service. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</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>) – A human readable description of the Supervisor Service. This
attribute was added in vSphere API 7.0.3.0.
If None, the description for the service version is empty.</p></li>
<li><p><strong>prefix</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 prefix that will be added to the names of the Supervisor
Service’s kubernetes resources. This attribute was added in vSphere
API 7.0.3.0.
If None, the prefix is not assigned yet.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Message</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">severity</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">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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Message</span></code> class contains the information
about the Supervisor Service configuration on a vSphere Supervisor cluster.
This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Message.MessageSeverity</span></code></a>) – Type of the message. This attribute was added in vSphere API
7.0.3.0.</p></li>
<li><p><strong>details</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Details about the message. This attribute was added in vSphere API
7.0.3.0.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">MessageSeverity</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Message.MessageSeverity</span></code> class represents
the severity of the message. This enumeration was added in vSphere API
7.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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageSeverity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error message. This is accompanied by vCenter event and/or alarm. This
class attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.INFO">
<code class="sig-name descname"><span class="pre">INFO</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.INFO" title="Permalink to this definition"></a></dt>
<dd><p>Informational message. This may be accompanied by vCenter event. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.WARNING">
<code class="sig-name descname"><span class="pre">WARNING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">MessageSeverity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning message. This may be accompanied by vCenter event. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.SetSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">SetSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">service_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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.SetSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.SetSpec</span></code> class provides a specification
required to set a new configuration on a Supervisor Service in a vSphere
Supervisor cluster. This class is applied in entirety, replacing the
current specification fully. This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service version which contains the
service definition. This Supervisor Service version must be in the
<code class="docutils literal notranslate"><span class="pre">State#ACTIVATED</span></code> state. This attribute was added in vSphere API
7.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">com.vmware.vcenter.namespace_management.supervisor_services.Version</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.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
<li><p><strong>service_config</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>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A generic key-value map for additional configuration parameters
required during service upgrade. As an example, a third party
operator might reference a private registry using parameters such
as “registryName” for the registry name, “registryUsername” and
“registryPassword” for the registry credentials. This attribute was
added in vSphere API 7.0.3.0.
If None, no additional configuration parameters will be applied
when upgrading a Supervisor Service in the vSphere Supervisor
cluster.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</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">desired_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">config_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">current_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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Summary</span></code> class contains the basic
information about a Supervisor Service on the vSphere Supervisor cluster.
This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the Supervisor Service. This attribute was added
in vSphere API 7.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">com.vmware.vcenter.namespace_management.SupervisorService</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.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>desired_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The desired version of this Supervisor Service. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.ConfigStatus</span></code></a>) – Current setting for <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.ConfigStatus</span></code>.
This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>current_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>) – The current version for the Supervisor Service. This attribute was
added in vSphere API 7.0.3.0.
If None, there is no version installed for the Supervisor Service.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a Supervisor Service on the specified vSphere Supervisor
cluster. This method will apply the Supervisor Service version’s
service definition on the cluster. This method is possible only when
the Supervisor Service and Supervisor Service version are in the
<code class="docutils literal notranslate"><span class="pre">State#ACTIVATED</span></code> state. This method was added in vSphere API
7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor cluster on which to create the
service.
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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.CreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.CreateSpec</span></code></a>) – Specification for the Supervisor Service on the cluster.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 a Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisorService</span></code> exists on
the Supervisor cluster</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified cluster with ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or Supervisor Service
with the ID <code class="docutils literal notranslate"><span class="pre">supervisorService</span></code> or version with the ID
{param.name version} could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 Supervisor cluster doesn’t support Supervisor Services, or
if the Supervisor Service cannot be created in the current state,
e.g. the supervisor service version is in the <code class="docutils literal notranslate"><span class="pre">State#DEACTIVATED</span></code>
state.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a Supervisor Service on the specified vSphere Supervisor
cluster. This method will remove the Supervisor Service with the
specified identifier from the cluster, by removing the corresponding
namespace and deleting the operator(s) associated with the Supervisor
Service. Note that this operation doesn’t deal with the application
instances that are created by the associated operator(s), so existing
application instances could be orphaned if users don’t clean or migrate
them. This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor cluster from which to delete the
service.
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>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor cluster with the ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or the Supervisor
Service does not exist on the Supervisor cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 Supervisor cluster doesn’t support Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.get" title="Permalink to this definition"></a></dt>
<dd><p>Return information about the specific Supervisor Service on the
specified vSphere Supervisor cluster. This method was added in vSphere
API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster on which to get the service.
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>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Info" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The information for the specified Supervisor Service on the
specified cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor cluster with the ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or the Supervisor
Service does not exist on the Supervisor cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 Supervisor cluster doesn’t support Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the System.Read privilege on the
specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.list" title="Permalink to this definition"></a></dt>
<dd><p>Return the summaries about all Supervisor Services on the specified
vSphere Supervisor cluster. This method was added in vSphere API
7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster on which to list the services.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.list" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Summary" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The list of summaries of all Supervisor Services on the cluster.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor cluster with the ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 Supervisor cluster doesn’t support Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the System.Read privilege on the
specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.set">
<code class="sig-name descname"><span class="pre">set</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">supervisor_service</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.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.set" title="Permalink to this definition"></a></dt>
<dd><p>Set a new configuration to the specified Supervisor Service on the
specified vSphere Supervisor cluster. This method will apply the new
Supervisor Service version’s service definition to the existing
Supervisor Service on the cluster. This method requires that the
specified Supervisor Service is already installed in the specified
vSphere Supervisor cluster. Note that this operation doesn’t interfere
with the application instances that are created by the associated
operator(s). So users should make sure the new version is still
compatible with the existing application instances. This method was
added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor cluster from which to delete the
service.
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>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.SetSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.SetSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClusterSupervisorServices.SetSpec</span></code></a>) – Specification for the Supervisor Service on the cluster.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor cluster with the ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or Supervisor Service
with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> or version with the ID
{param.name version} could not be located, or the Supervisor
Service does not exist on the Supervisor cluster.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor cluster doesn’t support Supervisor Services or
the specified version is not in the <code class="docutils literal notranslate"><span class="pre">State#ACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.</span></code><code class="sig-name descname"><span class="pre">Versions</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions</span></code> class provides methods to manage a version object of a
Supervisor Service. A Supervisor Service version can be enabled on the
vSphere Supervisor clusters. This class was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ContentType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.ContentType</span></code> class defines the type of content that
describes the format of Supervisor Service version definition. This
enumeration was added in vSphere API 7.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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ContentType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CUSTOM_YAML">
<code class="sig-name descname"><span class="pre">CUSTOM_YAML</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ContentType(string='CUSTOM_YAML')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CUSTOM_YAML" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor Service version definition is provided as inline YAML
document that doesn’t follow the vSphere application service format, just
like any custom operator. This class attribute was added in vSphere API
7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.VSPHERE_APPS_YAML">
<code class="sig-name descname"><span class="pre">VSPHERE_APPS_YAML</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ContentType(string='VSPHERE_APPS_YAML')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.VSPHERE_APPS_YAML" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor Service version definition is provided as inline YAML
document that follows the vSphere application service format. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">custom_spec</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">vsphere_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.vcenter.namespace_management.supervisor_services_client.Versions.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.CreateSpec</span></code> class provides a specification required to
create a Supervisor Service version. This class was added in vSphere API
7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>custom_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CustomCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The specification required to create a Supervisor Service version
from inline content that is not based on the vSphere application
service format, instead a plain Kubernetes YAML format.</p>
<p>Exactly one of <code class="docutils literal notranslate"><span class="pre">customSpec</span></code> or <code class="docutils literal notranslate"><span class="pre">vsphereSpec</span></code> must be
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.. This attribute was added in vSphere API 7.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the service version will be created from inline
content based on a plain Kubernetes YAML format.</p>
</p></li>
<li><p><strong>vsphere_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.VsphereCreateSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>The specification required to create a Supervisor Service version
from inline content that is based on the vSphere application
service format.</p>
<p>Exactly one of <code class="docutils literal notranslate"><span class="pre">customSpec</span></code> or <code class="docutils literal notranslate"><span class="pre">vsphereSpec</span></code> must be
<code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>.. This attribute was added in vSphere API 7.0.3.0.
If <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>, the service version will be created from inline
content based on the vSphere application service format.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">CustomCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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">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">content</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">trusted_provider</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.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.CustomCreateSpec</span></code> class provides a specification required
to create a Supervisor Service version from a custom format that doesn’t
follow the vSphere application service format, just like any custom
operator. This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the Supervisor Service version. This must be an
alphanumeric (a-z and 0-9) string and with maximum length of 63
characters and with the ‘-‘ and ‘.’ characters allowed anywhere
except the first or last character. This attribute was added in
vSphere API 7.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">com.vmware.vcenter.namespace_management.supervisor_services.Version</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.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A human readable name of the Supervisor Service version. This
attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</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>) – A human readable description of the Supervisor Service version.
This attribute was added in vSphere API 7.0.3.0.
If None, the description for the service version will be empty.</p></li>
<li><p><strong>content</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Inline content that contains all service definition of the version,
which shall be base64 encoded. The service definition here doesn’t
follow the vSphere application service format. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>trusted_provider</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>) – Whether or not the Supervisor Service version is from a trusted
provider, this field must be set to false if the service version is
not from a trusted provider. If it is set to be true, but the
<code class="docutils literal notranslate"><span class="pre">content</span></code> is not signed or the signature is invalid, an
<code class="docutils literal notranslate"><span class="pre">InvalidArgument</span></code> will be thrown. This attribute was added in
vSphere API 7.0.3.0.
If None, the default value is true. In this case, the <code class="docutils literal notranslate"><span class="pre">content</span></code>
must be signed and will be verified.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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">eula</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">content_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">content</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">trust_verified</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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Info</span></code> class contains detailed information about a
Supervisor Service version. This class was added in vSphere API 7.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</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>) – The human readable name of the Supervisor Service version. This
attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</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>) – A human-readable description of the Supervisor Service version.
This attribute was added in vSphere API 7.0.3.0.
If None, no description is available for the Supervisor Service
version.</p></li>
<li><p><strong>eula</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 End User License Agreement (EULA) associated with the
Supervisor Service version. This attribute was added in vSphere API
7.0.3.0.
If None, no EULA is available for the Supervisor Service version.</p></li>
<li><p><strong>content_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.ContentType</span></code></a>) – The content type of <code class="docutils literal notranslate"><span class="pre">content</span></code>. This attribute was added in
vSphere API 7.0.3.0.</p></li>
<li><p><strong>content</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>) – Inline content that contains base64 encoded service definition for
the version. This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>trust_verified</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If true, the Supervisor Service version is from trusted provider
and the trust is verified. This attribute was added in vSphere API
7.0.3.0.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.State</span></code></a>) – The current <code class="docutils literal notranslate"><span class="pre">Versions.State</span></code> of the version. This attribute was
added in vSphere API 7.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.State</span></code> class defines the state of a Supervisor Service
version. This enumeration was added in vSphere API 7.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="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State.ACTIVATED">
<code class="sig-name descname"><span class="pre">ACTIVATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ACTIVATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State.ACTIVATED" title="Permalink to this definition"></a></dt>
<dd><p>The is the default state of a Supervisor Service version upon creation. In
this state, all operations on the version should work as normal. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State.DEACTIVATED">
<code class="sig-name descname"><span class="pre">DEACTIVATED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='DEACTIVATED')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State.DEACTIVATED" title="Permalink to this definition"></a></dt>
<dd><p>The is the deactivated state of a Supervisor Service version. In this
state, certain operations on the version are disallowed, for example, the
version cannot be created on the vSphere Supervisor clusters. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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">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">description</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.vcenter.namespace_management.supervisor_services_client.Versions.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.Summary</span></code> class contains the basic information about a
Supervisor Service version. This class was added in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the Supervisor Service version. This attribute
was added in vSphere API 7.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">com.vmware.vcenter.namespace_management.supervisor_services.Version</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.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A human readable name of the Supervisor Service version. This
attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.State</span></code></a>) – The current <code class="docutils literal notranslate"><span class="pre">Versions.State</span></code> of the Supervisor Service version.
This attribute was added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>description</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>) – A human readable description of the Supervisor Service version.
This attribute was added in vSphere API 7.0.3.0.
If None, no description is available for the service version.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">VsphereCreateSpec</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</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">trusted_provider</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">accept_eula</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.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.VsphereCreateSpec</span></code> class provides a specification required
to create a Supervisor Service version from vSphere application service
format, which shall contain the Supervisor Service identifier, version
identifier, display name and description information. This class was added
in vSphere API 7.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</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>content</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Inline content that contains all service definition of the version
in vSphere application service format, which shall be base64
encoded. The service definition here follows the vSphere
application service format. This attribute was added in vSphere API
7.0.3.0.</p></li>
<li><p><strong>trusted_provider</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>) – Whether or not the Supervisor Service version is from a trusted
provider, this field must be set to false if the service version is
not from a trusted provider. If it is set to be true, but the
<code class="docutils literal notranslate"><span class="pre">content</span></code> is not signed or the signature is invalid, an
<code class="docutils literal notranslate"><span class="pre">InvalidArgument</span></code> will be thrown. This attribute was added in
vSphere API 7.0.3.0.
If None, the default value is true. In this case, the <code class="docutils literal notranslate"><span class="pre">content</span></code>
must be signed and will be verified.</p></li>
<li><p><strong>accept_eula</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>) – Whether or not the End User License Agreement (EULA) that is
specified in the <code class="docutils literal notranslate"><span class="pre">content</span></code> is accepted. If a EULA is specified,
this attribute must be set to be true so that the Supervisor
Service version can be created. This attribute was added in vSphere
API 7.0.3.0.
If None, the default value is false.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.activate">
<code class="sig-name descname"><span class="pre">activate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.activate" title="Permalink to this definition"></a></dt>
<dd><p>Activate a Supervisor Service version. This method will change the
<code class="docutils literal notranslate"><span class="pre">Versions.State</span></code> of the version to <code class="docutils literal notranslate"><span class="pre">ACTIVATED</span></code> state. This method
was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service version cannot be activated in the
current state, for example, the Supervisor Service is in
<code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> or version
with the ID {param.name version} could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</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.vcenter.namespace_management.supervisor_services_client.Versions.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a Supervisor Service version based on the provided service
definition information for the version. This method was added in
vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CreateSpec</span></code></a>) – Specification for the Supervisor Service version to be created.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 a Supervisor Service version with the same identifier already
exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 an invalid field in <code class="docutils literal notranslate"><span class="pre">spec</span></code> is specified or if it contains any
errors. For example, when the field trusted is set to be true, but
no signature is provided or it is invalid or when a EULA is
specified but not accepted.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service version cannot be created in the current
state, for example, the Supervisor Service is in <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code>
state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not
be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.deactivate">
<code class="sig-name descname"><span class="pre">deactivate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.deactivate" title="Permalink to this definition"></a></dt>
<dd><p>Deactivate a Supervisor Service version. This method will change the
<code class="docutils literal notranslate"><span class="pre">Versions.State</span></code> of the version to <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code> state, which will
make sure the version cannot be created on any Supervisor cluster. Note
that this method should be called before deleting the version. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service version cannot be deactivated in the
current state, for example, the Supervisor Service is in
<code class="docutils literal notranslate"><span class="pre">ACTIVATED</span></code> state and this version is the last version of the
Supervisor Service in <code class="docutils literal notranslate"><span class="pre">ACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> or version
with the ID <code class="docutils literal notranslate"><span class="pre">version</span></code> could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete a Supervisor Service version. This method only deletes the
Supervisor Service version from vCenter if the version is in
<code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code> state and all instances of the version are removed from
all vSphere Supervisor clusters. Note that the <code class="docutils literal notranslate"><span class="pre">Version#deactivate</span></code>
method should be called to deactivate the version before the version
can be deleted.</p>
<p>Note that deleting the last version of the <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> does
not delete the <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> instance automatically.. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request,
e.g. if it is unable to reach a vSphere Supervisor cluster that has
the version enabled.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor Service version cannot be deleted in the current
state, e.g. the version is not in <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> or version
with the ID {param.name version} could not be located.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.get" title="Permalink to this definition"></a></dt>
<dd><p>Return the information for the specified Supervisor Service version.
This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Info" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information for the specified Supervisor Service version.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor Service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> or version
with the ID {param.name version} could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor_service</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.list" title="Permalink to this definition"></a></dt>
<dd><p>Return the information about all versions of the Supervisor Service.
This method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>supervisor_service</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.SupervisorService</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.list" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.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.vcenter.namespace_management.supervisor_services_client.Versions.Summary" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The list of summary of all service versions of the Supervisor
Service.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if service with the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> could not be located.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.vcenter.namespaces.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespaces package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.vcenter.lcm.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.lcm package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink