Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
Code
44eb68437b
vsphere-automation-sdk-python/vsphere/8.0.3.0/com.vmware.vcenter.namespace_management.html
bhagatp10 44eb68437b
Updated VC docs for v8.0.3.0 (#424) 
Signed-off-by: Prajwal Bhagat <prajwal.bhagat@broadcom.com>

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

4547 lines
482 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vcenter.namespace_management package &mdash; vSphere Automation SDK for Python. 8.0.3.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.namespace_management.networks package" href="com.vmware.vcenter.namespace_management.networks.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">
8.0.3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.esx_client">com.vmware.esx_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.snapservice_client">com.vmware.snapservice_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a></li>
<li class="breadcrumb-item active">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">
<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 heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html">com.vmware.vcenter.namespace_management.networks package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html">com.vmware.vcenter.namespace_management.networks.nsx package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#module-com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client">com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility"><code class="docutils literal notranslate"><span class="pre">Compatibility</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility.Summary"><code class="docutils literal notranslate"><span class="pre">Compatibility.Summary</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.Compatibility.check"><code class="docutils literal notranslate"><span class="pre">Compatibility.check()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.distributed_switches_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#module-com.vmware.vcenter.namespace_management.networks.nsx.edges_client">com.vmware.vcenter.namespace_management.networks.nsx.edges_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility"><code class="docutils literal notranslate"><span class="pre">Compatibility</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility.Summary"><code class="docutils literal notranslate"><span class="pre">Compatibility.Summary</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.Compatibility.check"><code class="docutils literal notranslate"><span class="pre">Compatibility.check()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.nsx.html#com.vmware.vcenter.namespace_management.networks.nsx.edges_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#module-com.vmware.vcenter.namespace_management.networks.edges_client">com.vmware.vcenter.namespace_management.networks.edges_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.Edge"><code class="docutils literal notranslate"><span class="pre">Edge</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider"><code class="docutils literal notranslate"><span class="pre">EdgeProvider</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.HAPROXY"><code class="docutils literal notranslate"><span class="pre">EdgeProvider.HAPROXY</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX"><code class="docutils literal notranslate"><span class="pre">EdgeProvider.NSX</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.EdgeProvider.NSX_ADVANCED"><code class="docutils literal notranslate"><span class="pre">EdgeProvider.NSX_ADVANCED</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.HAProxyConfig"><code class="docutils literal notranslate"><span class="pre">HAProxyConfig</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize"><code class="docutils literal notranslate"><span class="pre">LoadBalancerSize</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.LARGE"><code class="docutils literal notranslate"><span class="pre">LoadBalancerSize.LARGE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.MEDIUM"><code class="docutils literal notranslate"><span class="pre">LoadBalancerSize.MEDIUM</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.LoadBalancerSize.SMALL"><code class="docutils literal notranslate"><span class="pre">LoadBalancerSize.SMALL</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.NSXAdvancedLBConfig"><code class="docutils literal notranslate"><span class="pre">NSXAdvancedLBConfig</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.NSXConfig"><code class="docutils literal notranslate"><span class="pre">NSXConfig</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode"><code class="docutils literal notranslate"><span class="pre">NSXRoutingMode</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.NAT"><code class="docutils literal notranslate"><span class="pre">NSXRoutingMode.NAT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.NSXRoutingMode.ROUTED"><code class="docutils literal notranslate"><span class="pre">NSXRoutingMode.ROUTED</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.Server"><code class="docutils literal notranslate"><span class="pre">Server</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#module-com.vmware.vcenter.namespace_management.networks.nsx_client">com.vmware.vcenter.namespace_management.networks.nsx_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches"><code class="docutils literal notranslate"><span class="pre">DistributedSwitches</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.FilterSpec"><code class="docutils literal notranslate"><span class="pre">DistributedSwitches.FilterSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.Summary"><code class="docutils literal notranslate"><span class="pre">DistributedSwitches.Summary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.DistributedSwitches.list"><code class="docutils literal notranslate"><span class="pre">DistributedSwitches.list()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges"><code class="docutils literal notranslate"><span class="pre">Edges</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.FilterSpec"><code class="docutils literal notranslate"><span class="pre">Edges.FilterSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.Summary"><code class="docutils literal notranslate"><span class="pre">Edges.Summary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.Edges.list"><code class="docutils literal notranslate"><span class="pre">Edges.list()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.nsx_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#module-com.vmware.vcenter.namespace_management.networks.service_client">com.vmware.vcenter.namespace_management.networks.service_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.service_client.DNS"><code class="docutils literal notranslate"><span class="pre">DNS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.service_client.NTP"><code class="docutils literal notranslate"><span class="pre">NTP</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.service_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html">com.vmware.vcenter.namespace_management.software package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#module-com.vmware.vcenter.namespace_management.software.supervisors_client">com.vmware.vcenter.namespace_management.software.supervisors_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks"><code class="docutils literal notranslate"><span class="pre">Prechecks</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks.FilterSpec"><code class="docutils literal notranslate"><span class="pre">Prechecks.FilterSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks.Info"><code class="docutils literal notranslate"><span class="pre">Prechecks.Info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks.PrecheckResult"><code class="docutils literal notranslate"><span class="pre">Prechecks.PrecheckResult</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks.PrecheckSpec"><code class="docutils literal notranslate"><span class="pre">Prechecks.PrecheckSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks.get"><code class="docutils literal notranslate"><span class="pre">Prechecks.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.Prechecks.run"><code class="docutils literal notranslate"><span class="pre">Prechecks.run()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.software.html#com.vmware.vcenter.namespace_management.software.supervisors_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html">com.vmware.vcenter.namespace_management.supervisors package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html">com.vmware.vcenter.namespace_management.supervisors.networks package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#module-com.vmware.vcenter.namespace_management.supervisors.networks.management_client">com.vmware.vcenter.namespace_management.supervisors.networks.management_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network"><code class="docutils literal notranslate"><span class="pre">Network</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking"><code class="docutils literal notranslate"><span class="pre">NetworkBacking</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum"><code class="docutils literal notranslate"><span class="pre">NetworkBackingEnum</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum.NETWORK"><code class="docutils literal notranslate"><span class="pre">NetworkBackingEnum.NETWORK</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum.NETWORK_SEGMENT"><code class="docutils literal notranslate"><span class="pre">NetworkBackingEnum.NETWORK_SEGMENT</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration"><code class="docutils literal notranslate"><span class="pre">ProxyConfiguration</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource"><code class="docutils literal notranslate"><span class="pre">ProxySettingsSource</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.CLUSTER_CONFIGURED"><code class="docutils literal notranslate"><span class="pre">ProxySettingsSource.CLUSTER_CONFIGURED</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.NONE"><code class="docutils literal notranslate"><span class="pre">ProxySettingsSource.NONE</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource.VC_INHERITED"><code class="docutils literal notranslate"><span class="pre">ProxySettingsSource.VC_INHERITED</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#module-com.vmware.vcenter.namespace_management.supervisors.networks.workload_client">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network"><code class="docutils literal notranslate"><span class="pre">Network</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType"><code class="docutils literal notranslate"><span class="pre">NetworkType</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.NSXT"><code class="docutils literal notranslate"><span class="pre">NetworkType.NSXT</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType.VSPHERE"><code class="docutils literal notranslate"><span class="pre">NetworkType.VSPHERE</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork"><code class="docutils literal notranslate"><span class="pre">NsxNetwork</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork"><code class="docutils literal notranslate"><span class="pre">VSphereNetwork</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html">com.vmware.vcenter.namespace_management.supervisors.recovery package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#module-com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client">com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Archives"><code class="docutils literal notranslate"><span class="pre">Archives</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Archives.FilterSpec"><code class="docutils literal notranslate"><span class="pre">Archives.FilterSpec</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Archives.Info"><code class="docutils literal notranslate"><span class="pre">Archives.Info</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Archives.list"><code class="docutils literal notranslate"><span class="pre">Archives.list()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Jobs"><code class="docutils literal notranslate"><span class="pre">Jobs</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Jobs.CreateSpec"><code class="docutils literal notranslate"><span class="pre">Jobs.CreateSpec</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.Jobs.create"><code class="docutils literal notranslate"><span class="pre">Jobs.create()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.backup_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#module-com.vmware.vcenter.namespace_management.supervisors.recovery.restore_client">com.vmware.vcenter.namespace_management.supervisors.recovery.restore_client module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.restore_client.Jobs"><code class="docutils literal notranslate"><span class="pre">Jobs</span></code></a><ul>
<li class="toctree-l6"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.restore_client.Jobs.create"><code class="docutils literal notranslate"><span class="pre">Jobs.create()</span></code></a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.recovery.html#com.vmware.vcenter.namespace_management.supervisors.recovery.restore_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#module-com.vmware.vcenter.namespace_management.supervisors.identity_client">com.vmware.vcenter.namespace_management.supervisors.identity_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers"><code class="docutils literal notranslate"><span class="pre">Providers</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.CreateSpec"><code class="docutils literal notranslate"><span class="pre">Providers.CreateSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Info"><code class="docutils literal notranslate"><span class="pre">Providers.Info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.SetSpec"><code class="docutils literal notranslate"><span class="pre">Providers.SetSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.Summary"><code class="docutils literal notranslate"><span class="pre">Providers.Summary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.UpdateSpec"><code class="docutils literal notranslate"><span class="pre">Providers.UpdateSpec</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.create"><code class="docutils literal notranslate"><span class="pre">Providers.create()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.delete"><code class="docutils literal notranslate"><span class="pre">Providers.delete()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.get"><code class="docutils literal notranslate"><span class="pre">Providers.get()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.list"><code class="docutils literal notranslate"><span class="pre">Providers.list()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.set"><code class="docutils literal notranslate"><span class="pre">Providers.set()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.Providers.update"><code class="docutils literal notranslate"><span class="pre">Providers.update()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.identity_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#module-com.vmware.vcenter.namespace_management.supervisors.networks_client">com.vmware.vcenter.namespace_management.supervisors.networks_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.networks_client.NetworkSegment"><code class="docutils literal notranslate"><span class="pre">NetworkSegment</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.networks_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#module-com.vmware.vcenter.namespace_management.supervisors.recovery_client">com.vmware.vcenter.namespace_management.supervisors.recovery_client module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.html#com.vmware.vcenter.namespace_management.supervisors.recovery_client.StubFactory"><code class="docutils literal notranslate"><span class="pre">StubFactory</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-com.vmware.vcenter.namespace_management.clusters_client">
<span id="com-vmware-vcenter-namespace-management-clusters-client-module"></span><h2>com.vmware.vcenter.namespace_management.clusters_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.clusters_client" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.clusters_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.clusters_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.clusters_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.clusters_client.Topology">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.clusters_client.</span></span><span class="sig-name descname"><span class="pre">Topology</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.clusters_client.Topology" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Topology</span></code> class provides methods to query the topological layout of
the infrastructure a Supervisor is running on. This class was added in
vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.clusters_client.Topology.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.clusters_client.Topology.get" title="Permalink to this definition"></a></dt>
<dd><p>Queries the Supervisor ID that is currently running on the given
vSphere Cluster ID, if there’s any. A Supervisor can be running on one
or multiple vSphere Zones, and each vSphere Zone is associated with one
or more vSphere Clusters. This method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for a vSphere Cluster.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Identifier of the Supervisor associated with the given vSphere
Cluster.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.consumption_domains.Zone</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 given vSphere Cluster does not exist.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have <code class="docutils literal notranslate"><span class="pre">Namespaces.Manage</span></code> privilege and the
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code> privilege on all vSphere Clusters hosting the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<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 heading"></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 Persistent Services capabilities on VC clusters.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.cns_client.</span></span><span class="sig-name descname"><span class="pre">MaintenanceActionType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.EnsureAccessibility">
<span class="sig-name descname"><span class="pre">EnsureAccessibility</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.NoAction">
<span class="sig-name descname"><span class="pre">NoAction</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType.PermanentRemoval">
<span class="sig-name descname"><span class="pre">PermanentRemoval</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.cns_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.cns_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.vcenter.namespace_management.networks_client">
<span id="com-vmware-vcenter-namespace-management-networks-client-module"></span><h2>com.vmware.vcenter.namespace_management.networks_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.networks_client" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPAssignment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.</span></span><span class="sig-name descname"><span class="pre">IPAssignment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">assignee</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">ranges</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.networks_client.IPAssignment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">IPAssignment</span></code> class is used to assign IP addresses to be used for
various functions in a Supervisor Kubernetes Cluster. This class was added
in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>assignee</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment" title="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPAssignment.Assignment</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPAssignment.assignee</span></code> is the role assignee for the given IP
Ranges. This attribute was added in vSphere API 8.0.0.1.
This field defaults to ANY.</p></li>
<li><p><strong>ranges</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.networks_client.IPRange" title="com.vmware.vcenter.namespace_management.networks_client.IPRange"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRange</span></code></a>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPAssignment.ranges</span></code> lists the available IP addresses that
can be consumed by Supervisor to run the cluster. This attribute
was added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Assignment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">IPAssignment.Assignment</span></code> lists the different entities that require IP
ranges. These assignments fulfill different needs in the Kubernetes
environment. This enumeration was added in vSphere API 8.0.0.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Assignment</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.NODE">
<span class="sig-name descname"><span class="pre">NODE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Assignment(string='NODE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.NODE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.NODE" title="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.NODE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IPAssignment.Assignment.NODE</span></code></a> represents IP ranges that is allocated
to nodes for both the control plane and Tanzu Kubernetes Grid Clusters.
This assignment is currently only applicable on VDS networks. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.POD">
<span class="sig-name descname"><span class="pre">POD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Assignment(string='POD')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.POD" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.POD" title="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.POD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IPAssignment.Assignment.POD</span></code></a> represents the IP address that is
allocatable to Kubernetes Pods. This assignment is currently only
applicable on NSX-T networks. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.SERVICE">
<span class="sig-name descname"><span class="pre">SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Assignment(string='SERVICE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.SERVICE" title="Permalink to this definition"></a></dt>
<dd><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.SERVICE" title="com.vmware.vcenter.namespace_management.networks_client.IPAssignment.Assignment.SERVICE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IPAssignment.Assignment.SERVICE</span></code></a> represents the IP ranges that
Kubernetes can use for its cluster IP addresses. Cluster IPs are internal
to the cluster, but can be exposed via edge services such as load balancer,
ingress, and egress. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPManagement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.</span></span><span class="sig-name descname"><span class="pre">IPManagement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dhcp_enabled</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gateway_address</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">ip_assignments</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.networks_client.IPManagement" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">IPManagement</span></code> class dictates IP addressing configuration for the network
that hosts the Supervisor. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dhcp_enabled</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPManagement.dhcp_enabled</span></code> If set true, configures IP
address using the DHCP server on the broadcast domain unless the
corresponding <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPManagement.ip_assignments</span></code> are set. This
attribute was added in vSphere API 8.0.0.1.
If None this field defaults to true.</p></li>
<li><p><strong>gateway_address</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPManagement.gateway_address</span></code> is the IP address combined
with the subnet prefix length (e.g. 192.168.1.1/24) of the default
gateway of this network. This attribute was added in vSphere API
8.0.0.1.
If <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPManagement.dhcp_enabled</span></code> is not set, or this is an NSX
network, this address must be set.</p></li>
<li><p><strong>ip_assignments</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.networks_client.IPAssignment" title="com.vmware.vcenter.namespace_management.networks_client.IPAssignment"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPAssignment</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPManagement.ip_assignments</span></code> are a list of roles that can be
allocated to IP addresses. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPManagement.gateway_address</span></code>
is specified, these assignments must be on the same subnet. This
attribute was added in vSphere API 8.0.0.1.
These assignments are optional when using DHCP.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.IPRange">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.</span></span><span class="sig-name descname"><span class="pre">IPRange</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</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">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks_client.IPRange" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">IPRange</span></code> class is used to express a range of IP addresses. The IP
address supported by this structure will depend on the IP version that is
being used by Supervisor.</p>
<p>Currently, the Supervisor only supports IPv4.. This class was added in
vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">IPRange.address</span></code> is the starting IP address of the
<code class="docutils literal notranslate"><span class="pre">IPRange</span></code>. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>count</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">IPRange.count</span></code> is number of IP addresses in the range.</p>
<p>For example:</p>
<p>A /24 subnet will have a count of 256.</p>
<p>A /24 subnet with a gateway address and a broadcast address will
have a count of 254.. This attribute was added in vSphere API
8.0.0.1.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.Services">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.</span></span><span class="sig-name descname"><span class="pre">Services</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dns</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">ntp</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.networks_client.Services" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Services</span></code> class describes services that assists applications in
communicating on a network. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dns</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.service_client.DNS" title="com.vmware.vcenter.namespace_management.networks.service_client.DNS"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks.service_client.DNS</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Services.dns</span></code> describes DNS servers and search domains for a
given network. This attribute was added in vSphere API 8.0.0.1.
If unset, no DNS settings will be configured.</p></li>
<li><p><strong>ntp</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.service_client.NTP" title="com.vmware.vcenter.namespace_management.networks.service_client.NTP"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks.service_client.NTP</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Services.ntp</span></code> describes NTP servers running on this network
that networked applications can use for synchronizing time. This
attribute was added in vSphere API 8.0.0.1.
If unset, no NTP settings will be configured.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.networks_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.networks_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.networks_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.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 heading"></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.software_client.</span></span><span class="sig-name descname"><span class="pre">Clusters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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>, <em class="sig-param"><span class="n"><span class="pre">upgrade_prechecks</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">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<span class="colon">:</span></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>
<li><p><strong>upgrade_prechecks</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.html#com.vmware.vcenter.namespace_management_client.Clusters.Condition" title="com.vmware.vcenter.namespace_management_client.Clusters.Condition"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client.Clusters.Condition</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Detailed information about Supervisor upgrade pre-checks. This
attribute was added in vSphere API 8.0.3.0.
If None, the cluster pre-checks did not run or supervisor upgrade
is not available.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Message</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Severity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Severity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.INFO">
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Result</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Res</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Res</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED">
<span class="sig-name descname"><span class="pre">REJECTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.STARTED">
<span class="sig-name descname"><span class="pre">STARTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.State">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">State</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.PENDING">
<span class="sig-name descname"><span class="pre">PENDING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.READY">
<span class="sig-name descname"><span class="pre">READY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier 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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpgradeProgress</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpgradeSpec</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpgradeStatus</span></span><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>, <em class="sig-param"><span class="n"><span class="pre">components</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">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<span class="colon">:</span></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>
<li><p><strong>components</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.html#com.vmware.vcenter.namespace_management_client.Clusters.Condition" title="com.vmware.vcenter.namespace_management_client.Clusters.Condition"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client.Clusters.Condition</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about control plane components’ upgrade status. This
attribute was added in vSphere API 8.0.3.0.
If None, the cluster upgrade is not in progress.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster 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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the upgrade of the specified WCP enabled cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if cluster could not be located.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.list">
<span class="sig-name descname"><span class="pre">list</span></span><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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p>List of upgrade summary of all WCP enabled clusters.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade">
<span class="sig-name descname"><span class="pre">upgrade</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if pre-check failed of the cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Upgrade privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade_multiple">
<span class="sig-name descname"><span class="pre">upgrade_multiple</span></span><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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have Namespaces.Upgrade privilege on all
specified clusters.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.software_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.software_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.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 heading"></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.stats_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.stats_client.</span></span><span class="sig-name descname"><span class="pre">TimeSeries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PodIdentifier</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Spec</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ObjType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ObjType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER">
<span class="sig-name descname"><span class="pre">CLUSTER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE">
<span class="sig-name descname"><span class="pre">NAMESPACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD">
<span class="sig-name descname"><span class="pre">POD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TimeSeries</span></span><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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-com.vmware.vcenter.namespace_management.storage_client">
<span id="com-vmware-vcenter-namespace-management-storage-client-module"></span><h2>com.vmware.vcenter.namespace_management.storage_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.storage_client" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.storage_client.Profiles">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.storage_client.</span></span><span class="sig-name descname"><span class="pre">Profiles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Profiles</span></code> class provides methods to get storage profiles compatible
with control plane VMDKs which can be used to enable a Supervisor. A
storage profile is compatible if it results in at least one datastore in
each of the specified zones. This class was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">zones</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.storage_client.Profiles.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Profiles.FilterSpec</span></code> class contains zones used to find compatible
storage profiles. A storage profile is compatible if it results in at least
one datastore in each of the specified zones. (see <a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.check" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.check"><code class="xref py py-func docutils literal notranslate"><span class="pre">Profiles.check()</span></code></a>).
This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>zones</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>) – Zone compatibility criteria. The common storage profiles across the
given zones will be returned. A storage profile is considered
compatible if it results in at least one datastore in each of the
given zones. This attribute was added in vSphere API 8.0.0.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.consumption_domains.Zone</span></code>. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.consumption_domains.Zone</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.storage_client.Profiles.Item">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Item</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">zone</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">datastores</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.storage_client.Profiles.Item" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Profiles.Item</span></code> class contains the datastores and vSphere Zone which
they are in. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>zone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The vSphere Zones the datastore are in. This attribute was added in
vSphere API 8.0.0.1.
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.consumption_domains.Zone</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.consumption_domains.Zone</span></code>.</p></li>
<li><p><strong>datastores</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>) – The datastores in the zone. This attribute was added in vSphere API
8.0.0.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">Datastore</span></code>. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
resource type: <code class="docutils literal notranslate"><span class="pre">Datastore</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.storage_client.Profiles.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile</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">profile_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">compatible</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">items</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">incompatibility_reasons</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.storage_client.Profiles.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Profiles.Summary</span></code> class contains the information about compatible
storage profiles and represents the result of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.check" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.check"><code class="xref py py-func docutils literal notranslate"><span class="pre">Profiles.check()</span></code></a>
method. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>profile</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the compatible storage profile. A storage profile is
compatible if it results in at least one datastore in each of the
specified zones. This attribute was added in vSphere API 8.0.0.1.
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">SpsStorageProfile</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">SpsStorageProfile</span></code>.</p></li>
<li><p><strong>profile_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Human-readable identifier of the storage profile. This attribute
was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>compatible</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Compatibility of this storage profile with the specified vSphere
Zones. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>items</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.storage_client.Profiles.Item" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.Item</span></code></a>) – The list of <code class="docutils literal notranslate"><span class="pre">Profiles.Item</span></code> wich correspond to the storage
profile. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>incompatibility_reasons</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – The reason for incompatibility. If empty, this profile is
compatible with the given vSphere Zones specified in the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.FilterSpec</span></code></a>. This attribute was added in vSphere
API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.storage_client.Profiles.check">
<span class="sig-name descname"><span class="pre">check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.check" title="Permalink to this definition"></a></dt>
<dd><p>Returns the compatible management storage profiles for enabling a WCP
Supervisor across a given set of zones. A storage profile is compatible
if it results in at least one datastore in each of the specified zones.
This method was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.FilterSpec</span></code></a>) – Specification of the zones to consider when finding compatible
storage profiles. The <a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.FilterSpec</span></code></a> must contain at
least 1 zone.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.Summary" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of storage profiles compatible across the given
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.FilterSpec</span></code></a>. The profiles returned will each
result in at least one datastore in each zone.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if one or more fields of the <a class="reference internal" href="#com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec" title="com.vmware.vcenter.namespace_management.storage_client.Profiles.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Profiles.FilterSpec</span></code></a> is
incorrect.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have System.Read privilege on all of the
Cluster Compute Resources in the specified vSphere Zones.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.storage_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.storage_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.storage_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.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 heading"></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 Supervisor.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.</span></span><span class="sig-name descname"><span class="pre">ClusterSupervisorServices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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 Supervisors. This class was added in
vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConfigStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.CONFIGURED">
<span class="sig-name descname"><span class="pre">CONFIGURED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.CONFIGURING">
<span class="sig-name descname"><span class="pre">CONFIGURING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.ConfigStatus.REMOVING">
<span class="sig-name descname"><span class="pre">REMOVING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.CreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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>, <em class="sig-param"><span class="n"><span class="pre">yaml_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">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. 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<span class="colon">:</span></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">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">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.</p></li>
<li><p><strong>yaml_service_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>A set of additional configuration parameters to be applied during
service creation. These parameters should be formatted as a base64
encoded YAML document.</p>
<p>Parameters should be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> in at most one of
<code class="docutils literal notranslate"><span class="pre">serviceConfig</span></code> or <code class="docutils literal notranslate"><span class="pre">yamlServiceConfig</span></code>, and not both. The
<code class="docutils literal notranslate"><span class="pre">yamlServiceConfig</span></code> supports complex data types and nested
properties.. This attribute was added in vSphere API 8.0.0.1.
If None, no additional configuration parameters will be applied
when installing a Supervisor Service in the vSphere Supervisor.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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>, <em class="sig-param"><span class="n"><span class="pre">yaml_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.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ClusterSupervisorServices.Info</span></code> class contains the detailed
information about a Supervisor Service on the vSphere Supervisor. 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<span class="colon">:</span></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. 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>
<li><p><strong>yaml_service_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The configuration parameters applied on this Supervisor Service,
formatted as a base64 encoded YAML document. Any configuration that
has been <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> will be returned as base64 encoded YAML,
including the <code class="docutils literal notranslate"><span class="pre">serviceConfig</span></code>. This attribute was added in
vSphere API 8.0.0.1.
If None, the Supervisor Service has no configuration applied.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Message</span></span><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">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. 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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MessageSeverity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageSeverity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.INFO">
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Message.MessageSeverity.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.SetSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SetSpec</span></span><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>, <em class="sig-param"><span class="n"><span class="pre">yaml_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">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. 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<span class="colon">:</span></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">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.</p></li>
<li><p><strong>yaml_service_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>A set of additional configuration parameters to be applied during
service upgrade. These parameters should be formatted as a base64
encoded YAML document.</p>
<p>Parameters should be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> in at most one of
<code class="docutils literal notranslate"><span class="pre">serviceConfig</span></code> or <code class="docutils literal notranslate"><span class="pre">yamlServiceConfig</span></code>, and not both. The
<code class="docutils literal notranslate"><span class="pre">yamlServiceConfig</span></code> supports complex data types and nested
properties.. This attribute was added in vSphere API 8.0.0.1.
If None, no additional configuration parameters will be applied
when upgrading a Supervisor Service in the vSphere Supervisor.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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. 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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spec</span></span></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. 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">ACTIVATED</span></code> state.
A Supervisor can be running on one or multiple vSphere Zones, and each
vSphere Zone is associated with one or more vSphere Clusters. If a
Supervisor running on the specified vSphere Cluster is running on
additional vSphere Clusters, this operation will apply to Supervisor
components running on the other vSphere Clusters in addition to the
specified vSphere Cluster. To call this API on a Supervisor with
multiple vSphere Clusters, use
com.vmware.vcenter.namespace_management.supervisors.Topology#get to get
the vSphere Clusters associated with the given Supervisor. Any cluster
from the list returned can be used as the input of this API. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a Supervisor Service ID defined in <code class="docutils literal notranslate"><span class="pre">spec</span></code> exists on the
Supervisor</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified cluster with ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or Supervisor Service
with the Supervisor Service ID defined in <code class="docutils literal notranslate"><span class="pre">spec</span></code> or version with
the ID {param.name version} could not be located.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor 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">DEACTIVATED</span></code> state.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Install privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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. 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. A Supervisor can be
running on one or multiple vSphere Zones, and each vSphere Zone is
associated with one or more vSphere Clusters. If a Supervisor running
on the specified vSphere Cluster is running on additional vSphere
Clusters, this operation will apply to Supervisor components running on
the other vSphere Clusters in addition to the specified vSphere
Cluster. To call this API on a Supervisor with multiple vSphere
Clusters, use
com.vmware.vcenter.namespace_management.supervisors.Topology#get to get
the vSphere Clusters associated with the given Supervisor. Any cluster
from the list returned can be used as the input of this API. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor with the ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or the Supervisor Service
does not exist on the Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor doesn’t support Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Install privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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. A Supervisor can be running on one or
multiple vSphere Zones, and each vSphere Zone is associated with one or
more vSphere Clusters. If a Supervisor running on the specified vSphere
Cluster is running on additional vSphere Clusters, this operation will
apply to Supervisor components running on the other vSphere Clusters in
addition to the specified vSphere Cluster. To call this API on a
Supervisor with multiple vSphere Clusters, use
com.vmware.vcenter.namespace_management.supervisors.Topology#get to get
the vSphere Clusters associated with the given Supervisor. Any cluster
from the list returned can be used as the input of this API. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier 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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-odd"><p>The information for the specified Supervisor Service on the
specified cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor with the ID <code class="docutils literal notranslate"><span class="pre">cluster</span></code> or the Supervisor Service
does not exist on the Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor doesn’t support Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Install privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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. A Supervisor can be running on one or multiple
vSphere Zones, and each vSphere Zone is associated with one or more
vSphere Clusters. If a Supervisor running on the specified vSphere
Cluster is running on additional vSphere Clusters, this operation will
apply to Supervisor components running on the other vSphere Clusters in
addition to the specified vSphere Cluster. To call this API on a
Supervisor with multiple vSphere Clusters, use
com.vmware.vcenter.namespace_management.supervisors.Topology#get to get
the vSphere Clusters associated with the given Supervisor. Any cluster
from the list returned can be used as the input of this API. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier 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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-odd"><p>The list of summaries of all Supervisor Services on the cluster.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor doesn’t support Supervisor Services.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the System.Read privilege on the
specified cluster.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices.set">
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cluster</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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. 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 Supervisor. 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. A Supervisor can be running on one or multiple vSphere
Zones, and each vSphere Zone is associated with one or more vSphere
Clusters. If a Supervisor running on the specified vSphere Cluster is
running on additional vSphere Clusters, this operation will apply to
Supervisor components running on the other vSphere Clusters in addition
to the specified vSphere Cluster. To call this API on a Supervisor with
multiple vSphere Clusters, use
com.vmware.vcenter.namespace_management.supervisors.Topology#get to get
the vSphere Clusters associated with the given Supervisor. Any cluster
from the list returned can be used as the input of this API. This
method was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor 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.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor doesn’t support Supervisor Services or the
specified version is not in the <code class="docutils literal notranslate"><span class="pre">ACTIVATED</span></code> state.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Install privilege
on the specified cluster.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.</span></span><span class="sig-name descname"><span class="pre">Versions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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. This class was added in vSphere API 7.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CarvelCreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CarvelCreateSpec</span></span><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><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CarvelCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Versions.CarvelCreateSpec</span></code> class provides a specification required
to create a Supervisor Service version from Carvel application package
format (Package and PackageMetadata resources should be declared). This
class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>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 Carvel application package format, which shall be base64
encoded. This attribute was added in vSphere API 8.0.0.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ContentType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ContentType</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CARVEL_APPS_YAML">
<span class="sig-name descname"><span class="pre">CARVEL_APPS_YAML</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ContentType(string='CARVEL_APPS_YAML')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CARVEL_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 Carvel application package format. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.CUSTOM_YAML">
<span class="sig-name descname"><span class="pre">CUSTOM_YAML</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 follows a plain Kubernetes YAML format. This class attribute
was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.ContentType.VSPHERE_APPS_YAML">
<span class="sig-name descname"><span class="pre">VSPHERE_APPS_YAML</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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>, <em class="sig-param"><span class="n"><span class="pre">carvel_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">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. Exactly one of
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Versions.CreateSpec.custom_spec</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">Versions.CreateSpec.vsphere_spec</span></code> must be <code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code>. 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<span class="colon">:</span></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 based on a plain Kubernetes YAML
format.</p>
<p>. 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>. 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>
<li><p><strong>carvel_spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CarvelCreateSpec" title="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CarvelCreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions.CarvelCreateSpec</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 Carvel application package
format.</p>
<p>. This attribute was added in vSphere API 8.0.0.1.
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 Carvel application package format (Package and
PackageMetadata resources should be declared).</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.CustomCreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomCreateSpec</span></span><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">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 plain Kubernetes YAML format.
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<span class="colon">:</span></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 a
semantic 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>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 follows
a plain Kubernetes YAML 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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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>, <em class="sig-param"><span class="n"><span class="pre">registered_by_default</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">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<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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.
If None, no content is available for the Supervisor Service
version.</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>
<li><p><strong>registered_by_default</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If <code class="docutils literal notranslate"><span class="pre">true</span></code>, this Supervisor Service version has been registered on
vCenter by default and cannot be removed. If <code class="docutils literal notranslate"><span class="pre">false</span></code>, this
service version has been registered by an administrator. This
attribute was added in vSphere API 8.0.3.0.
This attribute is optional because it was added in a newer version
than its parent node.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">State</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.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">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="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State.ACTIVATED">
<span class="sig-name descname"><span class="pre">ACTIVATED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.State.DEACTIVATED">
<span class="sig-name descname"><span class="pre">DEACTIVATED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">State(string='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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">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<span class="colon">:</span></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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.VsphereCreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">VsphereCreateSpec</span></span><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">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<span class="colon">:</span></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. 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 class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.activate">
<span class="sig-name descname"><span class="pre">activate</span></span><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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if a Supervisor Service version with the same identifier already
exists.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.deactivate">
<span class="sig-name descname"><span class="pre">deactivate</span></span><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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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 Supervisors. Note that the <code class="docutils literal notranslate"><span class="pre">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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request,
e.g. if it is unable to reach a vSphere Supervisor that has the
version enabled.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if 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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the SupervisorServices.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information for the specified Supervisor Service version.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisor_services_client.Versions.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if 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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user doesn’t have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-com.vmware.vcenter.namespace_management.supervisors_client">
<span id="com-vmware-vcenter-namespace-management-supervisors-client-module"></span><h2>com.vmware.vcenter.namespace_management.supervisors_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.supervisors_client" title="Permalink to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client</span></code> module
provides classes for operating a Supervisor.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.CNSFileConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">CNSFileConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vsan_clusters</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.supervisors_client.CNSFileConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">CNSFileConfig</span></code> class contains the specification required to set the
configuration for Cloud Native Storage file volume support on Supervisor.
This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>vsan_clusters</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>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">CNSFileConfig.vsan_clusters</span></code> is a list of clusters to be
used for provisioning file volumes.</p>
<p>As a prerequisite these clusters must have vSAN and vSAN file
services enabled, and must be in the same vCenter as the
Supervisor.</p>
<p>Currently this list must have a single entry which is the cluster
identifier of the current cluster. This cluster must be a vSAN
cluster and must have vSAN File Service enabled.</p>
<p>If a cluster in the list is not a vSAN cluster or does not have
vSAN File Service enabled, an InvalidArgument error will be thrown
from
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.namespace_management_client.Clusters.enable" title="com.vmware.vcenter.namespace_management_client.Clusters.enable"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client.Clusters.enable()</span></code></a>,
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.namespace_management_client.Clusters.update" title="com.vmware.vcenter.namespace_management_client.Clusters.update"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client.Clusters.update()</span></code></a>
and
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.namespace_management_client.Clusters.set" title="com.vmware.vcenter.namespace_management_client.Clusters.set"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client.Clusters.set()</span></code></a>
APIs.</p>
<p>An empty list may be specified to disable file volume support on
the Supervisor.. This attribute was added in vSphere API 8.0.0.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">Conditions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Conditions</span></code> class provides methods to retrieve conditions related to
a particular Supervisor. This class was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Condition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">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">last_transition_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reason</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">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">messages</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Conditions.Condition</span></code> class defines an observation of the
configuration state of a Supervisor. This class was added in vSphere API
8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The type of the condition is a CamelCase, machine readable
identifier, indicating the configuration stage.
InfrastructureInitialized, ControlPlaneVMsDeployed and
ControlPlaneVMsConfigured are examples of such identifiers. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>description</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>) – Description of the condition type in a human readable format. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Condition.Status</span></code></a>) – The status of the condition. This attribute was added in vSphere
API 8.0.0.1.</p></li>
<li><p><strong>last_transition_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Last time the condition transitioned from one state to another. A
transition happens when the value of status or severity field
changes. This attribute was added in vSphere API 8.0.0.1.
if None, there are no ongoing operations related to bringing the
condition to the desired state.</p></li>
<li><p><strong>reason</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A brief CamelCase message indicating details about the reason for
the last transition. FailedWithSystemError,
ManagementDNSServersMissing and WaitForNodeUpgrade are examples of
such messages. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Severity</span></code></a>) – Provides an explicit classification of the reason identifier. Can
be set when the value of status is not TRUE. This attribute was
added in vSphere API 8.0.0.1.</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.supervisors_client.Conditions.Message" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Message</span></code></a>) – A list of human-readable messages that provide additional details
about the last transition. This attribute was added in vSphere API
8.0.0.1.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>Status of the condition, which can be one of TRUE, FALSE or UNKNOWN. This
enumeration was added in vSphere API 8.0.0.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status.FALSE">
<span class="sig-name descname"><span class="pre">FALSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='FALSE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status.FALSE" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the condition has not reached the desired state. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status.TRUE">
<span class="sig-name descname"><span class="pre">TRUE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='TRUE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status.TRUE" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the condition has reached the desired state. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status.UNKNOWN">
<span class="sig-name descname"><span class="pre">UNKNOWN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='UNKNOWN')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition.Status.UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the status of the condition can not be determined. This
class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.ConditionGroup">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConditionGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">conditions</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.supervisors_client.Conditions.ConditionGroup" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Conditions.ConditionGroup</span></code> class defines a group for the observation
of related configuration states of Supervisor. This class was added in
vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The type of the condition group is a CamelCase, machine readable
identifier, indicating the group of related configuration stages.
UpgradePrechecks, and Components are examples of such identifiers.
This attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>description</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>) – Description of the condition group type in a human readable format.
This attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>conditions</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.supervisors_client.Conditions.Condition" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Condition</span></code></a>) – Information about all the conditions constituting condition group,
each condition represents the configuration stage. This attribute
was added in vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Message">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Message</span></span><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.supervisors_client.Conditions.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Conditions.Message</span></code> class contains user-readable information related
to a <code class="docutils literal notranslate"><span class="pre">Conditions.Condition</span></code>. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Severity</span></code></a>) – Type of the message. This attribute was added in vSphere API
8.0.0.1.</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
8.0.0.1.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Severity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Conditions.Severity</span></code> class represents the severity of the message.
This enumeration was added in vSphere API 8.0.0.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Severity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Severity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Error message. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity.INFO">
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Severity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity.INFO" title="Permalink to this definition"></a></dt>
<dd><p>Informational message. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Severity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Severity.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>Warning message. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.get" title="Permalink to this definition"></a></dt>
<dd><p>Get all conditions of a given Supervisor. This method was added in
vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for a Supervisor.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Condition</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition" title="com.vmware.vcenter.namespace_management.supervisors_client.Conditions.Condition"><code class="xref py py-class docutils literal notranslate"><span class="pre">Conditions.Condition</span></code></a> objects related to the given
Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if authorization information cannot be retrieved.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the Supervisor cannot be found, or if the user does not have
read privilege on it.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">ContainerImageRegistries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ContainerImageRegistries</span></code> class provides methods to manage container
image registries on a Supervisor. Supervisor service and PodVM container
images will be pulled from those defined container registries. This class
was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.CreateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">image_registry</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">default_registry</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.supervisors_client.ContainerImageRegistries.CreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ContainerImageRegistries.CreateSpec</span></code> class provides a specification
required to create a container image registry. This class was added in
vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the container image registry. This name is unique across
all container image registries in one Supervisor. This attribute
was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>image_registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry" title="com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageRegistry</span></code></a>) – The <code class="xref py py-attr docutils literal notranslate"><span class="pre">ContainerImageRegistries.CreateSpec.image_registry</span></code>
class contains the specification required to configure a container
image registry endpoint. This attribute was added in vSphere API
8.0.3.0.</p></li>
<li><p><strong>default_registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Indicates if this container image registry serves as the default
option when multiple registries exist, and no specific registry is
specified. If there is already a default image registry, the new
registry set to default will overwrite the original default
setting. If there are one or more container image registries
associated with the Supervisor, but none of them is set as the
default, Docker Hub will be treated as the default. This attribute
was added in vSphere API 8.0.3.0.
If None, this registry is not used as the default option.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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">image_registry</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">default_registry</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.supervisors_client.ContainerImageRegistries.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ContainerImageRegistries.Info</span></code> class contains the detailed
information about the container image registry. This class was added in
vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the container image registry. This attribute was
added in vSphere API 8.0.3.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.ContainerImageRegistry</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.ContainerImageRegistry</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the container image registry. This attribute was added in
vSphere API 8.0.3.0.</p></li>
<li><p><strong>image_registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry" title="com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageRegistry</span></code></a>) – The <code class="xref py py-attr docutils literal notranslate"><span class="pre">ContainerImageRegistries.Info.image_registry</span></code> class
contains the specification of the container image registry
endpoint. This attribute was added in vSphere API 8.0.3.0.</p></li>
<li><p><strong>default_registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates if this registry is used as default. This attribute was
added in vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.UpdateSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">UpdateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">hostname</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">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</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">certificate_chain</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">default_registry</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.supervisors_client.ContainerImageRegistries.UpdateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ContainerImageRegistries.UpdateSpec</span></code> class contains the
specification required to update a container image registry. This class was
added in vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</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>) – Name of the container image registry. This attribute was added in
vSphere API 8.0.3.0.
If None then no update will be made.</p></li>
<li><p><strong>hostname</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>) – IP address or the hostname of the container image registry. This
attribute was added in vSphere API 8.0.3.0.
If None then no update will be made.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Port number of the container image registry. This attribute was
added in vSphere API 8.0.3.0.
If None then no update will be made.</p></li>
<li><p><strong>username</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 username to be used for username/password authentication with
this registry. This attribute was added in vSphere API 8.0.3.0.
If None then no update will be made.</p></li>
<li><p><strong>password</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 password for the user. This attribute was added in vSphere API
8.0.3.0.
If None then no update will be made.</p></li>
<li><p><strong>certificate_chain</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>) – certificateChain contains PEM-encoded CA chain which is used to
verify x509 certificates received from the server. This attribute
was added in vSphere API 8.0.3.0.
If None then no update will be made.</p></li>
<li><p><strong>default_registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Indicates if this registry is used as default. This attribute was
added in vSphere API 8.0.3.0.
If None then no update will be made.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</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.supervisors_client.ContainerImageRegistries.create" title="Permalink to this definition"></a></dt>
<dd><p>Defines a new container image registry for the given Supervisor. This
method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor on which the container image registry
is created.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.CreateSpec" title="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.CreateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerImageRegistries.CreateSpec</span></code></a>) – Specification for setting up the container image registry.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerImageRegistries.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the container image registry created on the
Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.AlreadyExists" title="com.vmware.vapi.std.errors_client.AlreadyExists"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.AlreadyExists</span></code></a>
if the name of the container image registry specified in <code class="docutils literal notranslate"><span class="pre">spec</span></code>
already exists.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other errors.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">supervisor</span></code> doesn’t exist.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the Namespaces.Manage privilege.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 this Supervisor cluster does not support configuring container
image registries.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">container_image_registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.delete" title="Permalink to this definition"></a></dt>
<dd><p>Delete the given container image registry from the given Supervisor.
This method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor on which the container image registry
is created.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>container_image_registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the container image registry.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.ContainerImageRegistry</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other errors.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">supervisor</span></code> or <code class="docutils literal notranslate"><span class="pre">container_image_registry</span></code> doesn’t exist.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the Namespaces.Manage privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">container_image_registry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.get" title="Permalink to this definition"></a></dt>
<dd><p>Get information about the given container image registry for the given
Supervisor. This method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor on which the container image registry
is created.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>container_image_registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the container image registry.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.ContainerImageRegistry</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerImageRegistries.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Information about the given container image registry for the given
Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other errors.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">supervisor</span></code> or <code class="docutils literal notranslate"><span class="pre">container_image_registry</span></code> doesn’t exist.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.list" title="Permalink to this definition"></a></dt>
<dd><p>Lists all container image registries on the given Supervisor. This
method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor on which the container image registry
is created.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.list" title="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.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.supervisors_client.ContainerImageRegistries.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerImageRegistries.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The list of all configured container image registries for the given
Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other errors.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">supervisor</span></code> doesn’t exist.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the System.Read privilege.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">container_image_registry</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.supervisors_client.ContainerImageRegistries.update" title="Permalink to this definition"></a></dt>
<dd><p>Update the given container image registry configuration for the given
Supervisor. This method was added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor on which the container image registry
is created.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p></li>
<li><p><strong>container_image_registry</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the container image registry.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.ContainerImageRegistry</span></code>.</p></li>
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.UpdateSpec" title="com.vmware.vcenter.namespace_management.supervisors_client.ContainerImageRegistries.UpdateSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContainerImageRegistries.UpdateSpec</span></code></a>) – Specification for updating the container image registry
configuration.</p></li>
</ul>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 the name of the container image registry specified in <code class="docutils literal notranslate"><span class="pre">spec</span></code>
already exists.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other errors.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">supervisor</span></code> or <code class="docutils literal notranslate"><span class="pre">container_image_registry</span></code> doesn’t exist.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">spec</span></code> contains any errors.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the Namespaces.Manage privilege.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 this Supervisor cluster does not support configuring container
image registries.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ContentLibrarySpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">ContentLibrarySpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content_library</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.supervisors_client.ContentLibrarySpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ContentLibrarySpec</span></code> class contains the specification required to
configure Content Libraries with a Supervisor. This class was added in
vSphere API 8.0.2.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>content_library</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">ContentLibrarySpec.content_library</span></code> is the Content Library
ID associated with a Supervisor. The Content Library specified
should exist in the vSphere inventory.. This attribute was added in
vSphere API 8.0.2.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.Library</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.content.Library</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ControlPlane">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">ControlPlane</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</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">login_banner</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">size</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">storage_policy</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.supervisors_client.ControlPlane" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">ControlPlane</span></code> class describes the control plane configuration. It allows
you to adjust configuration such as size, network, and storage required to
support the control plane runtime.. This class was added in vSphere API
8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network" title="com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network</span></code></a>) – <p>The management <code class="xref py py-attr docutils literal notranslate"><span class="pre">ControlPlane.network</span></code> is used by vCenter and
the control plane to manage the cluster. vCenter and the NSX (if
used) management plane must be accessible from this network.</p>
<p>The Supervisor requires that management network traffic is not L3
routable from workload network traffic.. This attribute was added
in vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>login_banner</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">ControlPlane.login_banner</span></code> is a disclaimer displayed prior
to login via the Kubectl plugin.. This attribute was added in
vSphere API 8.0.0.1.
If this banner is None, no message will be displayed to users.</p></li>
<li><p><strong>size</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint" title="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">ControlPlane.size</span></code> controls the size and resources allocated
to the Kubernetes API server and the worker nodes.. This attribute
was added in vSphere API 8.0.0.1.
Defaults to SMALL.</p></li>
<li><p><strong>storage_policy</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">ControlPlane.storage_policy</span></code> identifies the storage policy
backing the Supervisor Kubernetes API server.. This attribute was
added in vSphere API 8.0.0.1.
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">SpsStorageProfile</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">SpsStorageProfile</span></code>.
This resource is required.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">ImageRegistry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hostname</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">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</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">certificate_chain</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.supervisors_client.ImageRegistry" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">ImageRegistry</span></code> class contains the specification required to
configure container image registry endpoint. This class was added in
vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>hostname</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – IP address or the hostname of container image registry. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Port number of the container image registry. This attribute was
added in vSphere API 8.0.0.1.
If None, defaults to 443.</p></li>
<li><p><strong>username</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 username to be used for username/password authentication with
this registry. This attribute was added in vSphere API 8.0.3.0.
If None then the username/password authentication will not be used.</p></li>
<li><p><strong>password</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 password for the user. This attribute was added in vSphere API
8.0.3.0.
If None then the password is unset, only for write operations. For
read operations (GET and LIST), this value is always nil.</p></li>
<li><p><strong>certificate_chain</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>) – PEM-encoded CA chain which is used to verify x509 certificates
received from the server. This attribute was added in vSphere API
8.0.3.0.
If None then the verification will be skipped.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.ImageSyncConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">ImageSyncConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">registry</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">repository</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">kubernetes_content_library</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_libraries</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.supervisors_client.ImageSyncConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">ImageSyncConfig</span></code> class describes how the Supervisor Cluster and
Kubernetes retrieves VM and container images that will run on the cluster.
This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>registry</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry" title="com.vmware.vcenter.namespace_management.supervisors_client.ImageRegistry"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageRegistry</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.registry</span></code> class contains the
specification required to configure container image registry
endpoint. This attribute was added in vSphere API 8.0.0.1.
Defaults to Docker Hub if None.</p></li>
<li><p><strong>repository</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>) – <p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.repository</span></code> specifies the default
container image repository to use when the Kubernetes Pod
specification does not specify it. For example, <code class="docutils literal notranslate"><span class="pre">hub.docker.com</span></code>
is the image repository for a Pod whose image specification is
<code class="docutils literal notranslate"><span class="pre">hub.docker.com/nginx</span></code>.. This attribute was added in vSphere API
8.0.0.1.
If None, and if docker hub is the configured
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.registry</span></code>, then
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.repository</span></code> defaults to Docker Hub. If
Docker Hub is not the configured image registry,
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.repository</span></code> remains unset.</p>
<p>If {#member} repository is None, you must supply an image
repository in your Pod spec or else images will not be able to be
synced into the cluster.</p>
</p></li>
<li><p><strong>kubernetes_content_library</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>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.kubernetes_content_library</span></code> is the UUID of
the Content Library which holds the VM Images for Tanzu Kubernetes
Service for vSphere.</p>
<p>This Content Library should be subscribed to VMware’s hosted
vSphere Kubernetes Service Repository. Optionally, you can
configure your own local content library and host images locally..
This attribute was added in vSphere API 8.0.0.1.
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.content.Library</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.content.Library</span></code>.
If the Content Library identifier is None, you will not be able to
deploy Tanzu Kubernetes Clusters.</p>
</p></li>
<li><p><strong>content_libraries</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.supervisors_client.ContentLibrarySpec" title="com.vmware.vcenter.namespace_management.supervisors_client.ContentLibrarySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContentLibrarySpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.content_libraries</span></code> is a list of Content
Libraries that will be associated with a Supervisor.</p>
<p>This list refers to existing Content Libraries in the vSphere
inventory. These Content Libraries and the Content Library items
belonging to them will be read-only across all vSphere Namespaces.
This list cannot overlap with the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ImageSyncConfig.kubernetes_content_library</span></code>. . This
attribute was added in vSphere API 8.0.2.0.
If None, no additional Content Libraries will be set for the
Supervisor apart from the default Kubernetes Service Content
Library.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerOptions">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">KubeAPIServerOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">security</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.supervisors_client.KubeAPIServerOptions" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">KubeAPIServerOptions</span></code> declares options for the Kubernetes API Server.</p>
<p>The API server is used to manage workloads on the workload network.. This
class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>security</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerSecurity" title="com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerSecurity"><code class="xref py py-class docutils literal notranslate"><span class="pre">KubeAPIServerSecurity</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">KubeAPIServerOptions.security</span></code> allows you to specify
configuration options for the API server security.. This attribute
was added in vSphere API 8.0.0.1.
If None, default security parameters will be configured.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerSecurity">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">KubeAPIServerSecurity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">certificate_dns_names</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.supervisors_client.KubeAPIServerSecurity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">KubeAPIServerSecurity</span></code> class declares security options configured on the
Kubernetes API server. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>certificate_dns_names</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>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">KubeAPIServerSecurity.certificate_dns_names</span></code> lists
additional DNS names to associate with the Kubernetes API server.</p>
<p>These DNS names are embedded in the TLS certificate presented by
the API server as subject alternative names, which can be used in
conjunction with your DNS server to securely connect a client to
the server.. This attribute was added in vSphere API 8.0.0.1.</p>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">SizingHint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SizingHint</span></code> class determines the configuration of Kubernetes API
server and the worker nodes. It also determines the default values
associated with the maximum number of pods and services. Use
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get" title="com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management_client.ClusterSizeInfo.get()</span></code></a>
to get information associated with a <code class="docutils literal notranslate"><span class="pre">SizingHint</span></code>. This enumeration was
added in vSphere API 8.0.0.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint" title="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint"><code class="xref py py-class docutils literal notranslate"><span class="pre">SizingHint</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.LARGE">
<span class="sig-name descname"><span class="pre">LARGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SizingHint(string='LARGE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.LARGE" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of ‘large’. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.MEDIUM">
<span class="sig-name descname"><span class="pre">MEDIUM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SizingHint(string='MEDIUM')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.MEDIUM" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of ‘medium’. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.SMALL">
<span class="sig-name descname"><span class="pre">SMALL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SizingHint(string='SMALL')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.SMALL" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of ‘small’. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.TINY">
<span class="sig-name descname"><span class="pre">TINY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SizingHint(string='TINY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SizingHint.TINY" title="Permalink to this definition"></a></dt>
<dd><p>Cluster size of ‘tiny’. This class attribute was added in vSphere API
8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.StubFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">Summary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary</span></code> class provides methods to retrieve the current states of
Supervisors.</p>
<p>Only the basic information of the given Supervisor is being queried.. This
class was added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConfigStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary.ConfigStatus</span></code> class describes the status of reaching the
desired state configuration for the Supervisor. This enumeration was added
in vSphere API 8.0.0.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.CONFIGURING">
<span class="sig-name descname"><span class="pre">CONFIGURING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ConfigStatus(string='CONFIGURING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.CONFIGURING" title="Permalink to this definition"></a></dt>
<dd><p>The Namespace configuration is being applied to the Supervisor. This class
attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ConfigStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Failed to apply the Namespace configuration to the Supervisor, user
intervention needed. This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.REMOVING">
<span class="sig-name descname"><span class="pre">REMOVING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ConfigStatus(string='REMOVING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.REMOVING" title="Permalink to this definition"></a></dt>
<dd><p>The Namespace configuration is being removed from the Supervisor. This
class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.RUNNING">
<span class="sig-name descname"><span class="pre">RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ConfigStatus(string='RUNNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus.RUNNING" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor is configured correctly with the Namespace configuration.
This class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FilterSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">kubernetes_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.supervisors_client.Summary.FilterSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>A <code class="docutils literal notranslate"><span class="pre">Summary.FilterSpec</span></code> can be specified to filter summary output by any
allowed criteria. An empty <code class="docutils literal notranslate"><span class="pre">Summary.FilterSpec</span></code> will cause all results of
the query to be returned. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.ConfigStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Matches Supervisors with <code class="xref py py-attr docutils literal notranslate"><span class="pre">Summary.Info.config_status</span></code> equal
to the specified value. This attribute was added in vSphere API
8.0.0.1.
if None this filter is not applied.</p></li>
<li><p><strong>kubernetes_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.KubernetesStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Matches Supervisors with the <code class="xref py py-attr docutils literal notranslate"><span class="pre">Summary.Info.kubernetes_status</span></code>
equal to the specified value. This attribute was added in vSphere
API 8.0.0.1.
if None this filter is not applied.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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">stats</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">kubernetes_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.supervisors_client.Summary.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary.Info</span></code> class contains the basic information about the
statistics and status related to the Supervisor. This class was added in
vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the Supervisor. This attribute was added in vSphere API
8.0.0.1.</p></li>
<li><p><strong>stats</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.Stats" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Stats"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.Stats</span></code></a>) – Basic runtime statistics for the Supervisor. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>config_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ConfigStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.ConfigStatus</span></code></a>) – Current status of reaching the desired state configuration for the
Supervisor. This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>kubernetes_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.KubernetesStatus</span></code></a>) – Current Status of the Supervisor’s ability to deploy pods. This
attribute was added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">KubernetesStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary.KubernetesStatus</span></code> class describes the Supervisor’s ability
to deploy pods. This enumeration was added in vSphere API 8.0.0.1.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">KubernetesStatus</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">KubernetesStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor may not be able to accept pods and has error messages. This
class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus.READY">
<span class="sig-name descname"><span class="pre">READY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">KubernetesStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus.READY" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor is able to accept pods. This class attribute was added in
vSphere API 8.0.0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">KubernetesStatus(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.KubernetesStatus.WARNING" title="Permalink to this definition"></a></dt>
<dd><p>The Supervisor may be able to accept pods, but has warning messages. This
class attribute was added in vSphere API 8.0.0.1.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ListItem">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ListItem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ListItem" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary.ListItem</span></code> class contains information about a Supervisor
returned by <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.list" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Summary.list()</span></code></a> method. This class was added in vSphere
API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The immutable identifier of the Supervisor generated during
enablement. This attribute was added in vSphere API 8.0.0.1.
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.Supervisor</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.Supervisor</span></code>.</p></li>
<li><p><strong>info</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.Info</span></code></a>) – The current state of the Supervisor. This attribute was added in
vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ListResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ListResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</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.supervisors_client.Summary.ListResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary.ListResult</span></code> class represents the result of
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.list" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.list"><code class="xref py py-func docutils literal notranslate"><span class="pre">Summary.list()</span></code></a> method. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>items</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.supervisors_client.Summary.ListItem" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ListItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.ListItem</span></code></a>) – List of items. This attribute was added in vSphere API 8.0.0.1.</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Stats">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cpu_used</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">cpu_capacity</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">memory_used</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">memory_capacity</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">storage_used</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">storage_capacity</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.supervisors_client.Summary.Stats" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Summary.Stats</span></code> class contains the basic runtime statistics about a
Supervisor. This class was added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cpu_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Overall CPU usage of the Supervisor, in MHz. This is the sum of CPU
usage across all worker nodes in the Supervisor. This attribute was
added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>cpu_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total CPU capacity in the Supervisor, in MHz. This is the sum of
CPU capacities from all worker nodes in the Supervisor. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>memory_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Overall memory usage of the Supervisor, in mebibytes. This is the
sum of memory usage across all worker nodes in the Supervisor. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>memory_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total memory capacity of the Supervisor in mebibytes. This is the
sum of memory capacities from all worker nodes in the Supervisor.
This attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>storage_used</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Overall storage used by the Supervisor, in mebibytes. This is the
sum of storage used across all worker nodes in the Supervisor. This
attribute was added in vSphere API 8.0.0.1.</p></li>
<li><p><strong>storage_capacity</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Overall storage capacity of the Supervisor, in mebibytes. This is
the sum of total storage available from all worker nodes in the
Cluster. This attribute was added in vSphere API 8.0.0.1.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.get" title="Permalink to this definition"></a></dt>
<dd><p>Queries the current state of the specified Supervisor. This method was
added in vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the identifier for a supervisor
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.Info</span></code></a> of the Supervisor matching the provided
identifier.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 Supervisor matching the ID does not exist.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have <code class="docutils literal notranslate"><span class="pre">Namespaces.Manage</span></code> privilege and the
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code> privilege on all vSphere Clusters hosting the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Summary.list">
<span class="sig-name descname"><span class="pre">list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.list" title="Permalink to this definition"></a></dt>
<dd><p>Queries the current state of all Supervisors. Optionally, apply the
filter to Supervisors that match the criteria in the
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.FilterSpec</span></code></a>. This method was added in vSphere API
8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.FilterSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Set of parameters that can be used to constrain the results of the
method.
if None all records will be returned.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.ListResult" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.ListResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.ListResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>ListResult of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.Info</span></code></a> of all Supervisors matching the
criteria in the <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec" title="com.vmware.vcenter.namespace_management.supervisors_client.Summary.FilterSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Summary.FilterSpec</span></code></a>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have <code class="docutils literal notranslate"><span class="pre">Namespaces.Manage</span></code> privilege and the
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code> privilege on all vSphere Clusters hosting the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">SupervisorServices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices</span></code> class provides methods to install and manage
running instances of Supervisor Services on a Supervisor cluster. Existing
methods under
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices" title="com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor_services_client.ClusterSupervisorServices</span></code></a>
will be migrated to this interface. This class was added in vSphere API
8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Message</span></span><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.supervisors_client.SupervisorServices.Message" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.Message</span></code> class contains the information about the
Supervisor Service on a Supervisor, it could be compatibility information,
service status information, etc. This class was added in vSphere API
8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.Message.MessageSeverity</span></code></a>) – Type of the message. This attribute was added in vSphere API
8.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
8.0.3.0.
If None, message details are not required for taking actions.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MessageSeverity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.Message.MessageSeverity</span></code> class represents the
severity of the message. This enumeration was added in vSphere API 8.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">MessageSeverity</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity.ERROR">
<span class="sig-name descname"><span class="pre">ERROR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">MessageSeverity(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.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 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity.INFO">
<span class="sig-name descname"><span class="pre">INFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">MessageSeverity(string='INFO')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.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 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message.MessageSeverity.WARNING">
<span class="sig-name descname"><span class="pre">WARNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">MessageSeverity(string='WARNING')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.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 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PrecheckResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_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">original_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">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">status_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">precheck_finish_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>This class contains the result of the last valid
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.precheck()</span></code></a> method for installing or upgrading to a
Supervisor Service version on a specific Supervisor. This class was added
in vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>target_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the target Supervisor Service version that the
prechecks were running for. This attribute was added in vSphere API
8.0.3.0.</p></li>
<li><p><strong>original_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>) – Identifier of the version of the Supervisor Service installed on
the Supervisor at the time when the prechecks were performed. It
should always match the version of the Supervisor Service currently
installed on the Supervisor. If the Supervisor Service on the
Supervisor has been upgraded or deleted since the last prechecks,
the stale results will be purged. This attribute was added in
vSphere API 8.0.3.0.
If None, there was no version installed when the prechecks were
performed.</p></li>
<li><p><strong>status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.PrecheckResult.Status</span></code></a>) – Status of the last precheck result. This attribute was added in
vSphere API 8.0.3.0.</p></li>
<li><p><strong>status_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.supervisors_client.SupervisorServices.Message" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.Message</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A set of messages that provide additional details of the last valid
precheck result, including errors and warnings for potential
incompatibility. This attribute was added in vSphere API 8.0.3.0.
If None, the target version is compatible with the Supervisor.</p></li>
<li><p><strong>precheck_finish_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The timestamp at which the compatibility pre-check finished. This
attribute was added in vSphere API 8.0.3.0.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>Status of a precheck result, can be either compatible or incompatible. This
enumeration was added in vSphere API 8.0.3.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="bora/vspherevmodl2/enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Status</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status.COMPATIBLE">
<span class="sig-name descname"><span class="pre">COMPATIBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='COMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status.COMPATIBLE" title="Permalink to this definition"></a></dt>
<dd><p>The target version is compatible with the Supervisor. This class attribute
was added in vSphere API 8.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status.INCOMPATIBLE">
<span class="sig-name descname"><span class="pre">INCOMPATIBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Status(string='INCOMPATIBLE')</span></em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult.Status.INCOMPATIBLE" title="Permalink to this definition"></a></dt>
<dd><p>The target version is incompatible with the Supervisor. This class
attribute was added in vSphere API 8.0.3.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckSpec">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PrecheckSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_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.supervisors_client.SupervisorServices.PrecheckSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SupervisorServices.PrecheckSpec</span></code> class contains the specification
required to check whether a Supervisor Service version is compatible with
the Supervisor cluster. This class was added in vSphere API 8.0.3.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>target_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the Supervisor Service version that the prechecks are
running for. This attribute was added in vSphere API 8.0.3.0.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">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>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.get_precheck_result">
<span class="sig-name descname"><span class="pre">get_precheck_result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</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">target_version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.get_precheck_result" title="Permalink to this definition"></a></dt>
<dd><p>Get the result of the last valid <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.precheck()</span></code></a>
method for a specific Supervisor Service version on a Supervisor. If
the Supervisor Service on the Supervisor has been installed, upgraded
or deleted since the last <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.precheck()</span></code></a> method,
the stale result will be purged and the user should re-initiate a
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.precheck()</span></code></a> method. This method was added in
vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</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>target_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the target version to run the pre-check with.
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<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.PrecheckResult</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The result of the last valid <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.precheck()</span></code></a>
method for the Supervisor Service version on the Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor with the ID <code class="docutils literal notranslate"><span class="pre">supervisor</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
<code class="docutils literal notranslate"><span class="pre">target_version</span></code> could not be located or there is no valid
pre-check result available.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 Supervisor doesn’t support Supervisor Service or Supervisor
Service precheck.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Install privilege
on the specified Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other error.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.precheck">
<span class="sig-name descname"><span class="pre">precheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</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.supervisors_client.SupervisorServices.precheck" title="Permalink to this definition"></a></dt>
<dd><p>Initiates a pre-check for installing or upgrading to a Supervisor
Service version on the given Supervisor. For example, if a Supervisor
is running version 1.0 of a service, use this API with a target version
of 2.0 to know if the service version 2.0 is also compatible with this
Supervisor. The pre-check result can be fetched asynchronously by
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.get_precheck_result" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.get_precheck_result"><code class="xref py py-func docutils literal notranslate"><span class="pre">SupervisorServices.get_precheck_result()</span></code></a> method. This method was
added in vSphere API 8.0.3.0.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the Supervisor on which to initiate the pre-check.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</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 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.supervisors_client.SupervisorServices.PrecheckSpec" title="com.vmware.vcenter.namespace_management.supervisors_client.SupervisorServices.PrecheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">SupervisorServices.PrecheckSpec</span></code></a>) – Specification for the Supervisor Service pre-check.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The task identifier for the precheck operation.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.cis.task</span></code>.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if Supervisor with the ID <code class="docutils literal notranslate"><span class="pre">supervisor</span></code> or Supervisor Service with
the ID <code class="docutils literal notranslate"><span class="pre">supervisor_service</span></code> or the version defined in <code class="docutils literal notranslate"><span class="pre">spec</span></code>
could not be located.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the Supervisor is configuring or being removed.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
if the Supervisor doesn’t support Supervisor Service or Supervisor
Service precheck.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user cannot be authenticated.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have the SupervisorServices.Install privilege
on the specified Supervisor.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
for any other error.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Topology">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">Topology</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Topology" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Topology</span></code> class provides methods to query the topological layout of
the infrastructure a Supervisor is running on. This class was added in
vSphere API 8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Topology.Info">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">zone</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">clusters</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.supervisors_client.Topology.Info" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Topology.Info</span></code> class contains the basic information about the
association between vSphere Zones and vSphere Clusters. This class was
added in vSphere API 8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>zone</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of this vSphere Zone. This attribute was added in
vSphere API 8.0.0.1.
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.consumption_domains.Zone</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.consumption_domains.Zone</span></code>.</p></li>
<li><p><strong>clusters</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A list of vSphere Cluster identifiers that are associated with the
vSphere Zone. This attribute was added in vSphere API 8.0.0.1.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will contain identifiers for
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Topology.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">supervisor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.supervisors_client.Topology.get" title="Permalink to this definition"></a></dt>
<dd><p>Queries the current association between vSphere Zones and vSphere
Clusters from the given Supervisor ID. A Supervisor can be running on
one or multiple vSphere Zones, and each vSphere Zone is associated with
one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from
<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Topology.get" title="com.vmware.vcenter.namespace_management.supervisors_client.Topology.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Topology.get()</span></code></a> to call the APIs that requires a vSphere Cluster
ID instead of a Supervisor. This method was added in vSphere API
8.0.0.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>supervisor</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for a Supervisor.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisor.Supervisor</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Topology.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.Topology.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Topology.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.Topology.Info" title="com.vmware.vcenter.namespace_management.supervisors_client.Topology.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Topology.Info</span></code></a> of vSphere Zone and vSphere Cluster
associations.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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 given Supervisor does not exist.</p>
</dd>
<dt class="field-odd">Raise<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user can not be authenticated.</p>
</dd>
<dt class="field-even">Raise<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.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<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user does not have <code class="docutils literal notranslate"><span class="pre">Namespaces.Manage</span></code> privilege and the
<code class="docutils literal notranslate"><span class="pre">System.Read</span></code> privilege on all vSphere Clusters hosting the
Supervisor.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.Workloads">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">Workloads</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</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">edge</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">kube_api_server_options</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">images</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">storage</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.supervisors_client.Workloads" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Workloads</span></code> class describes configuration that affects the behavior and
lifecycle of Kubernetes workloads.. This class was added in vSphere API
8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>network</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.supervisors.networks.html#com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network" title="com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network</span></code></a>) – <p>The workloads <code class="xref py py-attr docutils literal notranslate"><span class="pre">Workloads.network</span></code> describes configuration for
the primary workload network.</p>
<p>Workloads will communicate with each other and will reach external
networks over this network.</p>
<p>The IP ranges configured on this network are managed primarily
within Kubernetes.. This attribute was added in vSphere API
8.0.0.1.</p>
</p></li>
<li><p><strong>edge</strong> (<a class="reference internal" href="com.vmware.vcenter.namespace_management.networks.html#com.vmware.vcenter.namespace_management.networks.edges_client.Edge" title="com.vmware.vcenter.namespace_management.networks.edges_client.Edge"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.networks.edges_client.Edge</span></code></a>) – <p><code class="xref py py-attr docutils literal notranslate"><span class="pre">Workloads.edge</span></code> configuration determines how network traffic
will enter and leave the cluster.</p>
<p>The IP ranges configured on this network are managed by the
Supervisor and the load balancer.. This attribute was added in
vSphere API 8.0.0.1.</p>
</p></li>
<li><p><strong>kube_api_server_options</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerOptions" title="com.vmware.vcenter.namespace_management.supervisors_client.KubeAPIServerOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">KubeAPIServerOptions</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Workloads.kube_api_server_options</span></code> declares configuration
options for the Kubernetes API Server.. This attribute was added in
vSphere API 8.0.0.1.
If None, the default configuration will be used.</p></li>
<li><p><strong>images</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.ImageSyncConfig" title="com.vmware.vcenter.namespace_management.supervisors_client.ImageSyncConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImageSyncConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Workloads.images</span></code> specifies how images will be stored and
pulled into the cluster.. This attribute was added in vSphere API
8.0.0.1.
If None, image sync configuration will default to the settings
described within the <code class="docutils literal notranslate"><span class="pre">ImageSyncConfig</span></code> class.</p></li>
<li><p><strong>storage</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.WorkloadsStorageConfig" title="com.vmware.vcenter.namespace_management.supervisors_client.WorkloadsStorageConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">WorkloadsStorageConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">Workloads.storage</span></code> specifies which persistent storage is
configured and accessible for workloads to consume. You can
configure policies for both images and volumes.. This attribute was
added in vSphere API 8.0.0.1.
If None, configuration will be copied from the control plane when
possible. If not, some storage features may be unavailable.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vcenter.namespace_management.supervisors_client.WorkloadsStorageConfig">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">com.vmware.vcenter.namespace_management.supervisors_client.</span></span><span class="sig-name descname"><span class="pre">WorkloadsStorageConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cloud_native_file_volume</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">ephemeral_storage_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">image_storage_policy</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.supervisors_client.WorkloadsStorageConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">VapiStruct</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">WorkloadsStorageConfig</span></code> class describes how vSphere and Kubernetes will
persist images and volumes to disk. This class was added in vSphere API
8.0.0.1.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cloud_native_file_volume</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.supervisors_client.CNSFileConfig" title="com.vmware.vcenter.namespace_management.supervisors_client.CNSFileConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">CNSFileConfig</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">WorkloadsStorageConfig.cloud_native_file_volume</span></code> specifies
the Cloud Native Storage file volume support on the Supervisor.
This feature provides <code class="docutils literal notranslate"><span class="pre">ReadWriteMany</span></code> container volumes support.
This attribute was added in vSphere API 8.0.0.1.
If None, file volume support will not be enabled on the Supervisor.</p></li>
<li><p><strong>ephemeral_storage_policy</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>) – <code class="xref py py-attr docutils literal notranslate"><span class="pre">WorkloadsStorageConfig.ephemeral_storage_policy</span></code> identifies
the storage policy associated with ephemeral disks of all the
Kubernetes PodVMs in the cluster. This attribute was added in
vSphere API 8.0.0.1.
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">SpsStorageProfile</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">SpsStorageProfile</span></code>.
If None during cluster enablement, the ephemeral storage policy
will be defaulted to the configured
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ControlPlane.storage_policy</span></code>.</p></li>
<li><p><strong>image_storage_policy</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 <code class="xref py py-attr docutils literal notranslate"><span class="pre">WorkloadsStorageConfig.image_storage_policy</span></code> class
contains the specification required to configure storage used for
PodVM container images. This attribute was added in vSphere API
8.0.0.1.
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">SpsStorageProfile</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">SpsStorageProfile</span></code>.
If None, the image storage policy will be set to the specified
<code class="xref py py-attr docutils literal notranslate"><span class="pre">WorkloadsStorageConfig.ephemeral_storage_policy</span></code> if
provided. This field will inherit any defaults for ephemeral
storage policy set by the system.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<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>
<a href="com.vmware.vcenter.namespace_management.networks.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespace_management.networks package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, Broadcom, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink