1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
vsphere-automation-sdk-python/vsphere/6.7.1/com.vmware.vcenter.vcha.html

1047 lines
69 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
2018-10-22 09:38:55 -04:00
<title>com.vmware.vcenter.vcha package &mdash; vSphere Automation SDK for Python 6.7U1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vcenter.vm package" href="com.vmware.vcenter.vm.html" />
<link rel="prev" title="com.vmware.vcenter.storage.policies package" href="com.vmware.vcenter.storage.policies.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
</a>
<div class="version">
2018-10-22 09:38:55 -04:00
6.7U1
</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.vcenter_client">com.vmware.vcenter_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">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vcenter.html">com.vmware.vcenter package</a> &raquo;</li>
<li>com.vmware.vcenter.vcha package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vcenter.vcha.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.vcha">
<span id="com-vmware-vcenter-vcha-package"></span><h1>com.vmware.vcenter.vcha package<a class="headerlink" href="#module-com.vmware.vcenter.vcha" 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.vcha.cluster_client">
<span id="com-vmware-vcenter-vcha-cluster-client-module"></span><h2>com.vmware.vcenter.vcha.cluster_client module<a class="headerlink" href="#module-com.vmware.vcenter.vcha.cluster_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha.cluster_client</span></code> module provides classes for
redeploying and monitoring a vCenter High Availability (VCHA) Cluster after a
successful initial deployment.</p>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Active">
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Active</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active" 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">Active</span></code> class provides methods to get information related to the
active vCenter High Availability (VCHA) node. This class was added in
vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Active.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>management=None</em>, <em>ha=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active.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">Active.Info</span></code> class contains the network and placement information of
the active node of a VCHA Cluster. This class was added in vSphere API 6.7
U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>management</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a>) IP specification for the Management network. This attribute was
added in vSphere API 6.7 U1.</li>
<li><strong>ha</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) IP specification for the HA network. This attribute was added in
vSphere API 6.7 U1.
If None, then the second NIC of the Active Node of the VCHA cluster
is not configured.</li>
<li><strong>placement</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementInfo" title="com.vmware.vcenter.vcha_client.PlacementInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.PlacementInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the placement information of the active node. This
attribute was added in vSphere API 6.7 U1.
If None, the request specified that placement information of the
active node should not be included.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Active.get">
<code class="descname">get</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>partial=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Active.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves information about the active node of a VCHA cluster. This
method was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>vc_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains active nodes management vCenter server credentials.
If None, then the active vCenter server is assumed to be managed by
itself.</li>
<li><strong>partial</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>) <p>If true, then return only the information that does not require
connecting to the Active vCenter Server.</p>
<blockquote>
<div>If false or unset, then return all the information.</div></blockquote>
<p>If None, then return all the information.</p>
</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Active.Info" title="com.vmware.vcenter.vcha.cluster_client.Active.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Active.Info</span></code></a></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Info Information about the VCHA network and placement of the active
node.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the credentials provided for authentincating with the active
nodes management vCenter server are invalid.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.</p>
<ul class="simple">
<li>If <code class="docutils literal notranslate"><span class="pre">partial</span></code> is false or unset, then the operation execution
requires the Global.VCServer privilege.</li>
<li>If <code class="docutils literal notranslate"><span class="pre">partial</span></code> is true, then the operation execution requires the
System.Read privilege.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code> will be a class
that contains all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CertificateInfo</span></code></a>.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementConfiguration</span></code>
If the active node is on more than one datastore.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
If the active virtual machine is not managed by the specified
vCenter server for the active node.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If the management interface IP address assignment is not static.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType">
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">DeploymentType</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType" 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 DeploymentType class provides methods to get the deployment type of a
vCenter High Availability Cluster (VCHA Cluster). This class was added in
vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>deployment_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.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">DeploymentType.Info</span></code> class contains the deployment type of the VCHA
Cluster. This class was added in vSphere API 6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>deployment_type</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type" title="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.Type</span></code></a>) Identifies the deployment type of the VCHA cluster. This attribute
was added in vSphere API 6.7 U1.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type">
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type" 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">DeploymentType.Type</span></code> class defines the possible deployment types for
a VCHA Cluster. This enumeration was added in vSphere API 6.7 U1.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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">Type</span></code> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.AUTO">
<code class="descname">AUTO</code><em class="property"> = Type(string='AUTO')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.AUTO" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster was deployed automatically. This class attribute was added in
vSphere API 6.7 U1.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.MANUAL">
<code class="descname">MANUAL</code><em class="property"> = Type(string='MANUAL')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.MANUAL" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster was deployed manually. This class attribute was added in
vSphere API 6.7 U1.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.NONE">
<code class="descname">NONE</code><em class="property"> = Type(string='NONE')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type.NONE" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster is not configured. This class attribute was added in vSphere
API 6.7 U1.</p>
</dd></dl>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.DeploymentType.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the deployment type of a VCHA cluster. This method was added
in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Info" title="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">DeploymentType.Info</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Info structure containing the deployment type information of the
the VCHA cluster.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the System.Read privilege.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode">
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Mode</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode" 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 Mode class provides methods to manage the operating mode of a vCenter
High Availability Cluster (VCHA Cluster). This class was added in vSphere
API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode">
<em class="property">class </em><code class="descname">ClusterMode</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode" 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">Mode.ClusterMode</span></code> class defines the possible modes for a VCHA
Cluster. This enumeration was added in vSphere API 6.7 U1.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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">ClusterMode</span></code> instance.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.DISABLED">
<code class="descname">DISABLED</code><em class="property"> = ClusterMode(string='DISABLED')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.DISABLED" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster is disabled. State replication between the Active and Passive
node is disabled and automatic failover is not allowed. This class
attribute was added in vSphere API 6.7 U1.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.ENABLED">
<code class="descname">ENABLED</code><em class="property"> = ClusterMode(string='ENABLED')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.ENABLED" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster is enabled. State replication between the Active and Passive
node is enabled and automatic failover is allowed. This class attribute was
added in vSphere API 6.7 U1.</p>
</dd></dl>
<dl class="attribute">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.MAINTENANCE">
<code class="descname">MAINTENANCE</code><em class="property"> = ClusterMode(string='MAINTENANCE')</em><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode.MAINTENANCE" title="Permalink to this definition"></a></dt>
<dd><p>VCHA Cluster is in maintenance mode. State replication between the and
Passive node is enabled but automatic failover is not allowed. This class
attribute was added in vSphere API 6.7 U1.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.Info">
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>mode=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.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">Mode.Info</span></code> class contains the mode of the VCHA Cluster. This class
was added in vSphere API 6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode" title="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mode.ClusterMode</span></code></a>) Identifies the mode of the VCHA cluster. This attribute was added
in vSphere API 6.7 U1.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the current mode of a VCHA cluster. This method was added in
vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Mode.Info" title="com.vmware.vcenter.vcha.cluster_client.Mode.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mode.Info</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Info structure containing the mode of the the VCHA cluster.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
If the VCHA cluster is not configured.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the System.Read privilege.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Mode.set_task">
<code class="descname">set_task</code><span class="sig-paren">(</span><em>mode</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Mode.set_task" title="Permalink to this definition"></a></dt>
<dd><p>Manipulates the mode of a VCHA Cluster. Following mode transitions are
allowed:</p>
<blockquote>
<div>enabled -&gt; disabled - Allowed only in healthy and degraded states.
enabled -&gt; maintenance - Allowed only in healthy state.
disabled -&gt; enabled - Allowed only in healthy state.</div></blockquote>
<p>maintenance -&gt; enabled - Allowed only in healthy state with all nodes
are running the same version.
maintenance -&gt; disabled - Allowed only in healthy state with all nodes
are running the same version.</p>
<blockquote>
<div>All other transitions are not allowed.</div></blockquote>
<p>VCHA Cluster configuration remains intact in any of the cluster modes..
This method was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode" title="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode"><code class="xref py py-class docutils literal notranslate"><span class="pre">Mode.ClusterMode</span></code></a>) Clustermode to change the VCHA cluster mode to.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive">
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Passive</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive" 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">Passive</span></code> class provides methods to validate a passives placement
configuration and redeploy the passive node in a vCenter High Availability
(VCHA) cluster. This class was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult">
<em class="property">class </em><code class="descname">CheckResult</code><span class="sig-paren">(</span><em>warnings=None</em>, <em>errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult" 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">Passive.CheckResult</span></code> class contains the warnings and errors that
will occur during the clone operation. This class was added in vSphere API
6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A list of problems which may require attention, but which are not
fatal. This attribute was added in vSphere API 6.7 U1.</li>
<li><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A list of problems which are fatal to the operation and the
operation will fail. This attribute was added in vSphere API 6.7
U1.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.CheckSpec">
<em class="property">class </em><code class="descname">CheckSpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckSpec" 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">Passive.CheckSpec</span></code> class contains placement information for
validation. This class was added in vSphere API 6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>vc_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the active nodes management vCenter server credentials.
This attribute was added in vSphere API 6.7 U1.
If None, then the active vCenter server is assumed to to be managed
by itself.</li>
<li><strong>placement</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) Contains the nodes placement information for validation. This
attribute was added in vSphere API 6.7 U1.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec">
<em class="property">class </em><code class="descname">RedeploySpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em>, <em>ha_ip=None</em>, <em>failover_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec" 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">Passive.RedeploySpec</span></code> class contains the redeploy specification.
This class was added in vSphere API 6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>vc_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the active nodes management vCenter server credentials.
This attribute was added in vSphere API 6.7 U1.
If None, then the active vCenter server is assumed to be managed by
itself.</li>
<li><strong>placement</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) Contains the nodes placement information. This attribute was added
in vSphere API 6.7 U1.</li>
<li><strong>ha_ip</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the VCHA HA network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network. This attribute was added in vSphere API
6.7 U1.
If None, then the stored network configuration for the VCHA HA
network for the passive node will be used.</li>
<li><strong>failover_ip</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Failover IP address that this node must assume after the failover
to serve client requests. This attribute was added in vSphere API
6.7 U1.
If None, then the public IP address of the Active vCenter Server is
assumed.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.check">
<code class="descname">check</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.check" title="Permalink to this definition"></a></dt>
<dd><p>Validates the specified passive nodes placement configuration. This
method was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckSpec" title="com.vmware.vcenter.vcha.cluster_client.Passive.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Passive.CheckSpec</span></code></a>) Contains the passive nodes placement specification.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult" title="com.vmware.vcenter.vcha.cluster_client.Passive.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Passive.CheckResult</span></code></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CheckResult structure containing errors and warnings.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the credentials provided for authentincating with the active
nodes management vCenter server are invalid.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the specified resource spec is deemed invalid for the clone
operation.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code> will be a class
that contains all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CertificateInfo</span></code></a>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
If the active virtual machine is not managed by the specified
vCenter server for the active node.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementConfiguration</span></code>
If the active node is on more than one datastore.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
If the clone operation is not allowed in the current state of the
system.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Passive.redeploy_task">
<code class="descname">redeploy_task</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Passive.redeploy_task" title="Permalink to this definition"></a></dt>
<dd><p>Creates the passive node in a degraded cluster with node location
information and pre-existing VCHA cluster configuration from the active
node. This method was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec" title="com.vmware.vcenter.vcha.cluster_client.Passive.RedeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Passive.RedeploySpec</span></code></a>) Contains the passive nodes redeploy specification.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the credentials provided for authentincating with the active
nodes management vCenter server are invalid.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code> will be a class
that contains all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CertificateInfo</span></code></a>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness">
<em class="property">class </em><code class="descclassname">com.vmware.vcenter.vcha.cluster_client.</code><code class="descname">Witness</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness" 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">Witness</span></code> class provides methods to validate a witnesss placement
configuration and redeploy the witness node in a vCenter High Availability
(VCHA) cluster. This class was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult">
<em class="property">class </em><code class="descname">CheckResult</code><span class="sig-paren">(</span><em>warnings=None</em>, <em>errors=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult" 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">Witness.CheckResult</span></code> class contains the warnings and errors that
will occur during the clone operation. This class was added in vSphere API
6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>warnings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A list of problems which may require attention, but which are not
fatal. This attribute was added in vSphere API 6.7 U1.</li>
<li><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) A list of problems which are fatal to the operation and the
operation will fail. This attribute was added in vSphere API 6.7
U1.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.CheckSpec">
<em class="property">class </em><code class="descname">CheckSpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckSpec" 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">Witness.CheckSpec</span></code> class contains placement information for
validation. This class was added in vSphere API 6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>vc_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the active nodes management vCenter server credentials.
This attribute was added in vSphere API 6.7 U1.
If None, then the active vCenter server is assumed to be managed by
itself.</li>
<li><strong>placement</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) Contains the nodes placement information for validation. This
attribute was added in vSphere API 6.7 U1.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec">
<em class="property">class </em><code class="descname">RedeploySpec</code><span class="sig-paren">(</span><em>vc_spec=None</em>, <em>placement=None</em>, <em>ha_ip=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec" 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">Witness.RedeploySpec</span></code> class contains the redeploy specification.
This class was added in vSphere API 6.7 U1.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">The arguments are used to initialize data attributes with the same
names.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>vc_spec</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec" title="com.vmware.vcenter.vcha_client.CredentialsSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the active nodes management vCenter server credentials.
This attribute was added in vSphere API 6.7 U1.
If None, then the active vCenter server is assumed to be managed by
itself.</li>
<li><strong>placement</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec" title="com.vmware.vcenter.vcha_client.PlacementSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) Contains the nodes placement information. This attribute was added
in vSphere API 6.7 U1.</li>
<li><strong>ha_ip</strong> (<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec" title="com.vmware.vcenter.vcha_client.IpSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) Contains the VCHA HA network configuration of the node. All cluster
communication (state replication, heartbeat, cluster messages)
happens over this network. This attribute was added in vSphere API
6.7 U1.
If None, then the stored network configuration for the VCHA HA
network for the witness node will be used.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.check">
<code class="descname">check</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.check" title="Permalink to this definition"></a></dt>
<dd><p>Validates the specified witness nodes placement configuration. This
method was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckSpec" title="com.vmware.vcenter.vcha.cluster_client.Witness.CheckSpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Witness.CheckSpec</span></code></a>) Contains the witness nodes placement specification.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult" title="com.vmware.vcenter.vcha.cluster_client.Witness.CheckResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">Witness.CheckResult</span></code></a></td>
</tr>
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">CheckResult structure containing errors and warnings.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the credentials provided for authentincating with the active
nodes management vCenter server are invalid.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the specified resource spec is deemed invalid for the clone
operation.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code> will be a class
that contains all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CertificateInfo</span></code></a>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
If the active virtual machine is not managed by the specified
vCenter server for the active node.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementConfiguration</span></code>
If the active node is on more than one datastore.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
If the clone operation is not allowed in the current state of the
system.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="com.vmware.vcenter.vcha.cluster_client.Witness.redeploy_task">
<code class="descname">redeploy_task</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vcenter.vcha.cluster_client.Witness.redeploy_task" title="Permalink to this definition"></a></dt>
<dd><p>Creates the witness node in a degraded cluster with node location
information and pre-existing VCHA cluster configuration from the active
node. This method was added in vSphere API 6.7 U1.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spec</strong> (<a class="reference internal" href="#com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec" title="com.vmware.vcenter.vcha.cluster_client.Witness.RedeploySpec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Witness.RedeploySpec</span></code></a>) Contains the witness nodes redeploy specification.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
If the credentials provided for authentincating with the active
nodes management vCenter server are invalid.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
If the user has insufficient privilege to perform the operation.
Operation execution requires the Global.VCServer privilege.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.UnverifiedPeer</span></code>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code> will be a class
that contains all the attributes defined in
<a class="reference internal" href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CertificateInfo" title="com.vmware.vcenter.vcha_client.CertificateInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vcenter.vcha_client.CertificateInfo</span></code></a>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code>
If any other error occurs.</td>
</tr>
</tbody>
</table>
</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.vm.html" class="btn btn-neutral float-right" title="com.vmware.vcenter.vm package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.vcenter.storage.policies.html" class="btn btn-neutral" title="com.vmware.vcenter.storage.policies package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2018, 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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>