<spanid="com-vmware-vcenter-namespace-management-package"></span><h1>com.vmware.vcenter.namespace_management package<aclass="headerlink"href="#module-com.vmware.vcenter.namespace_management"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-namespace-management-cns-client-module"></span><h2>com.vmware.vcenter.namespace_management.cns_client module<aclass="headerlink"href="#module-com.vmware.vcenter.namespace_management.cns_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management.cns_client.</span></code><codeclass="sig-name descname"><spanclass="pre">MaintenanceActionType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.cns_client.MaintenanceActionType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">MaintenanceActionType</span></code> class contains actions to be taken when an
entity enters maintenance mode.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname"><spanclass="pre">EnsureAccessibility</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MaintenanceActionType(string='EnsureAccessibility')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">NoAction</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MaintenanceActionType(string='NoAction')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">PermanentRemoval</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">MaintenanceActionType(string='PermanentRemoval')</span></em><aclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management.cns_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.cns_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-namespace-management-software-client-module"></span><h2>com.vmware.vcenter.namespace_management.software_client module<aclass="headerlink"href="#module-com.vmware.vcenter.namespace_management.software_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Clusters</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters</span></code> class provides methods to upgrade the vSphere clusters.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">current_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">available_versions</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">last_upgraded_date</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">state</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">upgrade_status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Info</span></code> class contains detailed information about the cluster
upgrade status and related information.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>current_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Current version of the cluster.</p></li>
<li><p><strong>available_versions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Set of available versions can be upgraded to.</p></li>
<li><p><strong>last_upgraded_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message"title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the cluster version.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State"title="com.vmware.vcenter.namespace_management.software_client.Clusters.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.State</span></code></a>) – Current state of the upgrade.</p></li>
<li><p><strong>upgrade_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus"title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.UpgradeStatus</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about upgrade in progress.
If None, the cluster upgrade is not in progress.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Message</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">severity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Message</span></code> class contains the information about the object
configuration.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>severity</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity"title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Message.Severity</span></code></a>) – Type of the message.</p></li>
<li><p><strong>details</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Details about the message.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Severity</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message.Severity"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Message.Severity</span></code> class represents the severity of the
message.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Severity</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Severity(string='ERROR')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">INFO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Severity(string='INFO')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Severity(string='WARNING')</span></em><aclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Result</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">res</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">exception</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Result</span></code> class contains the result of batch upgrade method.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>res</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res"title="com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Result.Res</span></code></a>) – The result of batch upgrade method.</p></li>
<li><p><strong>exception</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">res</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Clusters.Result.Res.REJECTED</span></code></a>.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Res</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Result.Res</span></code> class represents the upgrade invocation result
for each cluster.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Res</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">REJECTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Res(string='REJECTED')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">STARTED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Res(string='STARTED')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Result.Res.STARTED"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">State</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.State</span></code> class describes the state of the upgrade.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">State</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='ERROR')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">PENDING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='PENDING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State.PENDING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">READY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">State(string='READY')</span></em><aclass="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>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.Summary</span></code> class contains basic information about the cluster
upgrade related information.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p></li>
<li><p><strong>cluster_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource.name</span></code>.</p></li>
<li><p><strong>current_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Current version of the cluster.</p></li>
<li><p><strong>available_versions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Set of versions available for upgrade.</p></li>
<li><p><strong>last_upgraded_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.State"title="com.vmware.vcenter.namespace_management.software_client.Clusters.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.State</span></code></a>) – Current state of the upgrade.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradeProgress</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">total</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">completed</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.UpgradeProgress</span></code> class contains detailed information about
the cluster upgrade progess.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>total</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Message about the work progress.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradeSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">desired_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ignore_precheck_warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>desired_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version number the cluster is going to be upgraded to.</p></li>
<li><p><strong>ignore_precheck_warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">UpgradeStatus</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">desired_version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">messages</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">progress</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Clusters.UpgradeStatus</span></code> class contains detailed information about
the cluster when upgraded is in progress.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>desired_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.Message"title="com.vmware.vcenter.namespace_management.software_client.Clusters.Message"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.Message</span></code></a>) – Current set of messages associated with the upgrade state.</p></li>
<li><p><strong>progress</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress"title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeProgress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.UpgradeProgress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Information about upgrade progess.
If None, the cluster upgrade is not in progress.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster which will be upgraded.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">upgrade</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="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
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier for the cluster which will be upgraded.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">upgrade_multiple</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">specs</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>specs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"title="com.vmware.vcenter.namespace_management.software_client.Clusters.UpgradeSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Clusters.UpgradeSpec</span></code></a>) – Specifications for upgrading selected clusters.
The key in the parameter <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management.software_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.software_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vcenter-namespace-management-stats-client-module"></span><h2>com.vmware.vcenter.namespace_management.stats_client module<aclass="headerlink"href="#module-com.vmware.vcenter.namespace_management.stats_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management.stats_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.stats_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.namespace_management.stats_client.</span></code><codeclass="sig-name descname"><spanclass="pre">TimeSeries</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TimeSeries</span></code> class provides methods to gather statistical values for
clusters, namespaces and pods.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">PodIdentifier</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">pod_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier"title="Permalink to this definition">¶</a></dt>
<p>Pod identifier. These are the fields required to uniquely identify a pod.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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
<li><p><strong>pod_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the pod itself.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Spec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">obj_type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">pod</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">namespace</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">end</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec"title="Permalink to this definition">¶</a></dt>
<p>This structure is sent in a request for TimeSeries data and is used to
specify what object stats should be returned for.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>obj_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType"title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TimeSeries.Spec.ObjType</span></code></a>) – Type of statistics object that the request is operating on.</p></li>
<li><p><strong>pod</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier"title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.PodIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">objType</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TimeSeries.Spec.ObjType.POD</span></code></a>.</p></li>
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">objType</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TimeSeries.Spec.ObjType.NAMESPACE</span></code></a>.</p></li>
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">objType</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TimeSeries.Spec.ObjType.CLUSTER</span></code></a>.</p></li>
<li><p><strong>start</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – UNIX timestamp value indicating when the requested series of
<li><p><strong>end</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – UNIX timestamp value indicating when the requested series of
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">ObjType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec.ObjType"title="Permalink to this definition">¶</a></dt>
<p>Type of statistics object that this request is operating on.</p>
<divclass="admonition note">
<pclass="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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ObjType</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">CLUSTER</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjType(string='CLUSTER')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">NAMESPACE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjType(string='NAMESPACE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">POD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ObjType(string='POD')</span></em><aclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">TimeSeries</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">counter</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">time_stamps</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">values</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.TimeSeries"title="Permalink to this definition">¶</a></dt>
<p>A set of timestamps and statistical values representing a time series. The
lengths of <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TimeSeries.TimeSeries.time_stamps</span></code> and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">TimeSeries.TimeSeries.values</span></code> will always match each other.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
<li><p><strong>time_stamps</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Sequence of UNIX timestamp values at which statistical values were
<li><p><strong>values</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Sequence of sampled values corresponding to the timestamps in tss.</p></li>
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec"title="com.vmware.vcenter.namespace_management.stats_client.TimeSeries.Spec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">TimeSeries.Spec</span></code></a>) – Specification of the statistical values that should be returned.</p>
