mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
927 lines
72 KiB
HTML
927 lines
72 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" >
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware.vcenter.namespace_management package — vSphere Automation SDK for Python. 7.0.1.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<!--[if lt IE 9]>
|
|||
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|||
|
|
<script src="_static/jquery.js"></script>
|
|||
|
|
<script src="_static/underscore.js"></script>
|
|||
|
|
<script src="_static/doctools.js"></script>
|
|||
|
|
<script src="_static/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="com.vmware.vcenter.namespaces package" href="com.vmware.vcenter.namespaces.html" />
|
|||
|
|
<link rel="prev" title="com.vmware.vcenter.lcm package" href="com.vmware.vcenter.lcm.html" />
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home" alt="Documentation Home"> vSphere Automation SDK for Python.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
7.0.1.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python.</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.vcenter.namespace_management package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.vcenter.namespace_management.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.namespace_management">
|
|||
|
|
<span id="com-vmware-vcenter-namespace-management-package"></span><h1>com.vmware.vcenter.namespace_management package<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.namespace_management.software_client">
|
|||
|
|
<span id="com-vmware-vcenter-namespace-management-software-client-module"></span><h2>com.vmware.vcenter.namespace_management.software_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.software_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.software_client</span></code> module provides
|
|||
|
|
classes for managing namespaces software components.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.namespace_management.software_client.</code><code class="sig-name descname">Clusters</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters</span></code> class provides methods to upgrade the vSphere clusters.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Info">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Info</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">current_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">available_versions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_upgraded_date</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">upgrade_status</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Info</span></code> class contains detailed information about the cluster
|
|||
|
|
upgrade status and related information.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>current_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current version of the cluster.</p></li>
|
|||
|
|
<li><p><strong>available_versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Set of available versions can be upgraded to.</p></li>
|
|||
|
|
<li><p><strong>last_upgraded_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date of last successful upgrade.
|
|||
|
|
If None, the cluster has not yet been upgraded.</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the cluster version.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State" title="com.vmware.vcenter.namespace_management.software_client.Clusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.State</span></code></a>) – Current state of the upgrade.</p></li>
|
|||
|
|
<li><p><strong>upgrade_status</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeStatus</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about upgrade in progress.
|
|||
|
|
If None, the cluster upgrade is not in progress.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Message</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">severity</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Message</span></code> class contains the information about the object
|
|||
|
|
configuration.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>severity</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message.Severity</span></code></a>) – Type of the message.</p></li>
|
|||
|
|
<li><p><strong>details</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Details about the message.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Severity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Message.Severity</span></code> class represents the severity of the
|
|||
|
|
message.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Severity</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.ERROR">
|
|||
|
|
<code class="sig-name descname">ERROR</code><em class="property"> = Severity(string='ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Error message. This is accompanied by vCenter event and/or alarm.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.INFO">
|
|||
|
|
<code class="sig-name descname">INFO</code><em class="property"> = Severity(string='INFO')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.INFO" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Informational message. This may be accompanied by vCenter event.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.WARNING">
|
|||
|
|
<code class="sig-name descname">WARNING</code><em class="property"> = Severity(string='WARNING')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity.WARNING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Warning message. This may be accompanied by vCenter event.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Result</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">res</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">exception</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Result</span></code> class contains the result of batch upgrade method.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>res</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Result.Res</span></code></a>) – The result of batch upgrade method.</p></li>
|
|||
|
|
<li><p><strong>exception</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code>) – Exception when cluster pre-check failed during upgrade invocation.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">res</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Clusters.Result.Res.REJECTED</span></code></a>.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Res</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Result.Res</span></code> class represents the upgrade invocation result
|
|||
|
|
for each cluster.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Res</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED">
|
|||
|
|
<code class="sig-name descname">REJECTED</code><em class="property"> = Res(string='REJECTED')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.REJECTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Upgrade is rejected. This implies pre-check failed when invoking upgrade of
|
|||
|
|
the cluster.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.STARTED">
|
|||
|
|
<code class="sig-name descname">STARTED</code><em class="property"> = Res(string='STARTED')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.STARTED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Upgrade is started.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">State</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.State</span></code> class describes the state of the upgrade.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">State</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.ERROR">
|
|||
|
|
<code class="sig-name descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Upgrade failed and need user intervention.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.PENDING">
|
|||
|
|
<code class="sig-name descname">PENDING</code><em class="property"> = State(string='PENDING')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.PENDING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Upgrade is in progress.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.State.READY">
|
|||
|
|
<code class="sig-name descname">READY</code><em class="property"> = State(string='READY')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.READY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cluster is ready when there is no upgrade or upgrade is completed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.Summary">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Summary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">current_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">available_versions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">last_upgraded_date</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">desired_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Summary" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.Summary</span></code> class contains basic information about the cluster
|
|||
|
|
upgrade related information.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
|||
|
|
<li><p><strong>cluster_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the cluster.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource.name</span></code>. When methods return a value of
|
|||
|
|
this class as a return value, the attribute will be an identifier
|
|||
|
|
for the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource.name</span></code>.</p></li>
|
|||
|
|
<li><p><strong>current_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Current version of the cluster.</p></li>
|
|||
|
|
<li><p><strong>available_versions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Set of versions available for upgrade.</p></li>
|
|||
|
|
<li><p><strong>last_upgraded_date</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date of last successful upgrade.
|
|||
|
|
If None, the cluster has not yet been upgraded.</p></li>
|
|||
|
|
<li><p><strong>desired_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Desired version the cluster will be upgraded to.
|
|||
|
|
If None, the cluster upgrade is not in progress.</p></li>
|
|||
|
|
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State" title="com.vmware.vcenter.namespace_management.software_client.Clusters.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.State</span></code></a>) – Current state of the upgrade.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpgradeProgress</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">total</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">completed</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">message</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpgradeProgress</span></code> class contains detailed information about
|
|||
|
|
the cluster upgrade progess.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>total</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Total amount of the work for the operation. The work here
|
|||
|
|
represents the number of master nodes in the cluster need to be
|
|||
|
|
upgraded.</p></li>
|
|||
|
|
<li><p><strong>completed</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The amount of work completed for the operation. The value can only
|
|||
|
|
be incremented. The number or master nodes which upgrade completed.</p></li>
|
|||
|
|
<li><p><strong>message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message about the work progress.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpgradeSpec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">desired_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ignore_precheck_warnings</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpgradeSpec</span></code> class contains the specification required to
|
|||
|
|
upgrade a cluster.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>desired_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Version number the cluster is going to be upgraded to.</p></li>
|
|||
|
|
<li><p><strong>ignore_precheck_warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If true, the upgrade workflow will ignore any pre-check warnings
|
|||
|
|
and proceed with the upgrade.
|
|||
|
|
If None, the upgrade workflow will not ignore pre-check warnings
|
|||
|
|
and fail the upgrade. It is equivalent to setting the value to
|
|||
|
|
false. The workflow adopts a conservative approach of failing the
|
|||
|
|
upgrade if None to solely let the user decide whether to force the
|
|||
|
|
upgrade despite the warnings.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">UpgradeStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">desired_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">progress</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Clusters.UpgradeStatus</span></code> class contains detailed information about
|
|||
|
|
the cluster when upgraded is in progress.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>desired_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Desired version the cluster will be upgraded to.
|
|||
|
|
If None, the cluster upgrade is not in progress.</p></li>
|
|||
|
|
<li><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the upgrade state.</p></li>
|
|||
|
|
<li><p><strong>progress</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeProgress</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Information about upgrade progess.
|
|||
|
|
If None, the cluster upgrade is not in progress.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns upgrade related information of a specific cluster.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster which will be upgraded.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Info" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Info</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Information about the upgrade of the specified WCP enabled cluster.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if cluster could not be located.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user does not have System.Read privilege.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.list">
|
|||
|
|
<code class="sig-name descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Returns upgrade related information about all WCP enabled clusters.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Return type</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.list" title="com.vmware.vcenter.namespace_management.software_client.Clusters.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Summary" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Summary</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Returns</dt>
|
|||
|
|
<dd class="field-even"><p>List of upgrade summary of all WCP enabled clusters.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user does not have System.Read privilege.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade">
|
|||
|
|
<code class="sig-name descname">upgrade</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cluster</span></em>, <em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Upgrade the cluster to a specific version. This operation upgrades the
|
|||
|
|
components on control plane VMs and worker plane hosts based on the
|
|||
|
|
selected version. Before upgrading, this operation performs pre-checks
|
|||
|
|
and sets the evaluation response in Info.UpgradeStatus.messages with
|
|||
|
|
various Message.Severity levels. Depending on the severity, the upgrade
|
|||
|
|
may or may not proceed beyond prechecks. Here is a list of severities
|
|||
|
|
and corresponding behavior: - ERROR: Upgrade does not proceed beyond
|
|||
|
|
precheck operation - WARNING: Upgrade proceeds beyond precheck
|
|||
|
|
operation only if UpgradeSpec.ignorePrecheckWarnings is set to true -
|
|||
|
|
INFO: Upgrade proceeds beyond precheck operation uninterrupted</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the cluster which will be upgraded.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p></li>
|
|||
|
|
<li><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeSpec</span></code></a>) – Specification for upgrading the cluster.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if pre-check failed of the cluster.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if cluster could not be located.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user does not have Namespaces.Manage privilege.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade_multiple">
|
|||
|
|
<code class="sig-name descname">upgrade_multiple</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">specs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.upgrade_multiple" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Upgrade a set of clusters to its corresponding specific version.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>specs</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec" title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.UpgradeSpec</span></code></a>) – Specifications for upgrading selected clusters.
|
|||
|
|
The key in the parameter <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result" title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result"><code class="xref py py-class docutils literal notranslate"><span class="pre">Clusters.Result</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>Pre-check result when invoking upgrade for each cluster.
|
|||
|
|
The key in the return value <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user does not have Namespaces.Manage privilege on all
|
|||
|
|
specified clusters.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.software_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.namespace_management.software_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.software_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.vcenter.namespace_management.stats_client">
|
|||
|
|
<span id="com-vmware-vcenter-namespace-management-stats-client-module"></span><h2>com.vmware.vcenter.namespace_management.stats_client module<a class="headerlink" href="#module-com.vmware.vcenter.namespace_management.stats_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespace_management.stats_client</span></code> module provides
|
|||
|
|
classes for gathering statistics related to various Namespaces related
|
|||
|
|
components.</p>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.namespace_management.stats_client.</code><code class="sig-name descname">StubFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">stub_config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
<p>Initialize StubFactoryBase</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries">
|
|||
|
|
<em class="property">class </em><code class="sig-prename descclassname">com.vmware.vcenter.namespace_management.stats_client.</code><code class="sig-name descname">TimeSeries</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">TimeSeries</span></code> class provides methods to gather statistical values for
|
|||
|
|
clusters, namespaces and pods.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">PodIdentifier</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">namespace</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pod_name</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Pod identifier. These are the fields required to uniquely identify a pod.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The namespace that the pod is running in.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.</p></li>
|
|||
|
|
<li><p><strong>pod_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the pod itself.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">Spec</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">pod</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">namespace</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cluster</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>This structure is sent in a request for TimeSeries data and is used to
|
|||
|
|
specify what object stats should be returned for.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>obj_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType</span></code></a>) – Type of statistics object that the request is operating on.</p></li>
|
|||
|
|
<li><p><strong>pod</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.PodIdentifier</span></code></a>) – Pod Identifier for queries on an individual pod.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">objType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType.POD</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>namespace</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Namespace name for queries for a namespace.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>. When methods return a
|
|||
|
|
value of this class as a return value, the attribute will be an
|
|||
|
|
identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.namespaces.Instance</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">objType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType.NAMESPACE</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>cluster</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Cluster identifier for queries for a cluster.
|
|||
|
|
When clients pass a value of this class as a parameter, the
|
|||
|
|
attribute must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>. When methods return a value of this
|
|||
|
|
class as a return value, the attribute will be an identifier for
|
|||
|
|
the resource type: <code class="docutils literal notranslate"><span class="pre">ClusterComputeResource</span></code>.
|
|||
|
|
This attribute is optional and it is only relevant when the value
|
|||
|
|
of <code class="docutils literal notranslate"><span class="pre">objType</span></code> is <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER"><code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.ObjType.CLUSTER</span></code></a>.</p></li>
|
|||
|
|
<li><p><strong>start</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – UNIX timestamp value indicating when the requested series of
|
|||
|
|
statistical samples should begin.
|
|||
|
|
<a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">https://en.wikipedia.org/wiki/Unix_time</a></p></li>
|
|||
|
|
<li><p><strong>end</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – UNIX timestamp value indicating when the requested series of
|
|||
|
|
statistical samples should end.
|
|||
|
|
<a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">https://en.wikipedia.org/wiki/Unix_time</a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">ObjType</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">string</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>Type of statistics object that this request is operating on.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This class represents an enumerated type in the interface language
|
|||
|
|
definition. The class contains class attributes which represent the
|
|||
|
|
values in the current version of the enumerated type. Newer versions of
|
|||
|
|
the enumerated type may contain new values. To use new values of the
|
|||
|
|
enumerated type in communication with a server that supports the newer
|
|||
|
|
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">ObjType</span></code> instance.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER">
|
|||
|
|
<code class="sig-name descname">CLUSTER</code><em class="property"> = ObjType(string='CLUSTER')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.CLUSTER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The CLUSTER object type is used when specifying a vSphere cluster.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE">
|
|||
|
|
<code class="sig-name descname">NAMESPACE</code><em class="property"> = ObjType(string='NAMESPACE')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.NAMESPACE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The NAMESPACE object type is used to specify a namespace.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py attribute">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD">
|
|||
|
|
<code class="sig-name descname">POD</code><em class="property"> = ObjType(string='POD')</em><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType.POD" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The POD object type is used to specify an individual pod within a
|
|||
|
|
namespace.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py class">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries">
|
|||
|
|
<em class="property">class </em><code class="sig-name descname">TimeSeries</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">counter</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">time_stamps</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">values</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>A set of timestamps and statistical values representing a time series. The
|
|||
|
|
lengths of <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.TimeSeries.time_stamps</span></code> and
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.TimeSeries.values</span></code> will always match each other.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="admonition-title">Tip</p>
|
|||
|
|
<p>The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><ul class="simple">
|
|||
|
|
<li><p><strong>counter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Counter identifier.</p></li>
|
|||
|
|
<li><p><strong>time_stamps</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Sequence of UNIX timestamp values at which statistical values were
|
|||
|
|
sampled. <a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">https://en.wikipedia.org/wiki/Unix_time</a></p></li>
|
|||
|
|
<li><p><strong>values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Sequence of sampled values corresponding to the timestamps in tss.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="py method">
|
|||
|
|
<dt id="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.get">
|
|||
|
|
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">spec</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gather statistical values for a cluster, namespace, or pod.</p>
|
|||
|
|
<dl class="field-list simple">
|
|||
|
|
<dt class="field-odd">Parameters</dt>
|
|||
|
|
<dd class="field-odd"><p><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.Spec</span></code></a>) – Specification of the statistical values that should be returned.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Return type</dt>
|
|||
|
|
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries" title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeSeries.TimeSeries</span></code></a></p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Returns</dt>
|
|||
|
|
<dd class="field-odd"><p>A list of TimeSeries values for each counter specified in the
|
|||
|
|
request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
|
|||
|
|
if the system reports an error while responding to the request.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
|
|||
|
|
if the start time in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.start</span></code> is invalid, or
|
|||
|
|
the end time in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.end</span></code> is invalid.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
|||
|
|
if the specified cluster in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.cluster</span></code> or the
|
|||
|
|
namespace in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.namespace</span></code> or
|
|||
|
|
<code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.pod</span></code> does not exist.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unsupported" title="com.vmware.vapi.std.errors_client.Unsupported"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unsupported</span></code></a>
|
|||
|
|
if the specified cluster in <code class="xref py py-attr docutils literal notranslate"><span class="pre">TimeSeries.Spec.cluster</span></code> is not
|
|||
|
|
enabled for Namespaces.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-even">Raise</dt>
|
|||
|
|
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
|
|||
|
|
if the user can not be authenticated.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt class="field-odd">Raise</dt>
|
|||
|
|
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
|
|||
|
|
if the user does not have System.Read privilege.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vcenter.namespaces.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.namespaces package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.vcenter.lcm.html" class="btn btn-neutral float-left" title="com.vmware.vcenter.lcm package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
© Copyright 2020, VMware, Inc.
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
|||
|
|
|
|||
|
|
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
|||
|
|
|
|||
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|