<spanid="com-vmware-vcenter-vcha-package"></span><h1>com.vmware.vcenter.vcha package<aclass="headerlink"href="#module-com.vmware.vcenter.vcha"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-vcha-cluster-client-module"></span><h2>com.vmware.vcenter.vcha.cluster_client module<aclass="headerlink"href="#module-com.vmware.vcenter.vcha.cluster_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha.cluster_client</span></code> module provides classes for
redeploying and monitoring a vCenter High Availability (VCHA) Cluster after a
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha.cluster_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Active</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.vcha.cluster_client.Active"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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.1.</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">management</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ha</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement</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.vcha.cluster_client.Active.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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.1.</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>management</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.1.</p></li>
<li><p><strong>ha</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP specification for the HA network. This attribute was added in
vSphere API 6.7.1.
If None, then the second NIC of the Active Node of the VCHA cluster
is not configured.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementInfo"title="com.vmware.vcenter.vcha_client.PlacementInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.PlacementInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the placement information of the active node. This
attribute was added in vSphere API 6.7.1.
If None, the request specified that placement information of the
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vc_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">partial</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.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.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>vc_spec</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains active node’s management vCenter server credentials.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>partial</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="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><p>If false or unset, then return all the information.</p>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha.cluster_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DeploymentType</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.vcha.cluster_client.DeploymentType"title="Permalink to this definition">¶</a></dt>
<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.1.</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">deployment_type</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.vcha.cluster_client.DeploymentType.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.Info</span></code> class contains the deployment type of the VCHA
Cluster. This class was added in vSphere API 6.7.1.</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"><p><strong>deployment_type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type"title="com.vmware.vcenter.vcha.cluster_client.DeploymentType.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DeploymentType.Type</span></code></a>) – Identifies the deployment type of the VCHA cluster. This attribute
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Type</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.vcha.cluster_client.DeploymentType.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DeploymentType.Type</span></code> class defines the possible deployment types for
a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.</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">Type</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">AUTO</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='AUTO')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">MANUAL</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='MANUAL')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Type(string='NONE')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha.cluster_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Mode</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.vcha.cluster_client.Mode"title="Permalink to this definition">¶</a></dt>
<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.1.</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">ClusterMode</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.vcha.cluster_client.Mode.ClusterMode"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Mode.ClusterMode</span></code> class defines the possible modes for a VCHA
Cluster. This enumeration was added in vSphere API 6.7.1.</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">ClusterMode</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DISABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ClusterMode(string='DISABLED')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">ENABLED</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ClusterMode(string='ENABLED')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">MAINTENANCE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ClusterMode(string='MAINTENANCE')</span></em><aclass="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
<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">mode</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.vcha.cluster_client.Mode.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Mode.Info</span></code> class contains the mode of the VCHA Cluster. This class
was added in vSphere API 6.7.1.</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"><p><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode"title="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Mode.ClusterMode</span></code></a>) – Identifies the mode of the VCHA cluster. This attribute was added
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<codeclass="sig-name descname"><spanclass="pre">set_task</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mode</span></span></em><spanclass="sig-paren">)</span><aclass="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><p>enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.</p>
</div></blockquote>
<p>maintenance -> enabled - Allowed only in healthy state with all nodes
are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes
are running the same version.</p>
<blockquote>
<div><p>All other transitions are not allowed.</p>
</div></blockquote>
<p>VCHA Cluster configuration remains intact in any of the cluster modes..
This method was added in vSphere API 6.7.1.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>mode</strong> (<aclass="reference internal"href="#com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode"title="com.vmware.vcenter.vcha.cluster_client.Mode.ClusterMode"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Mode.ClusterMode</span></code></a>) – Clustermode to change the VCHA cluster mode to.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha.cluster_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Passive</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.vcha.cluster_client.Passive"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Passive</span></code> class provides methods to validate a passive’s placement
configuration and redeploy the passive node in a vCenter High Availability
(VCHA) cluster. This class was added in vSphere API 6.7.1.</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">CheckResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">errors</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.vcha.cluster_client.Passive.CheckResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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.1.</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>warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <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>) – A list of problems which may require attention, but which are not
fatal. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <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>) – A list of problems which are fatal to the operation and the
operation will fail. This attribute was added in vSphere API 6.7.1.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vc_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement</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.vcha.cluster_client.Passive.CheckSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Passive.CheckSpec</span></code> class contains placement information for
validation. This class was added in vSphere API 6.7.1.</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>vc_spec</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the active node’s management vCenter server credentials.
This attribute was added in vSphere API 6.7.1.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) – Contains the node’s placement information for validation. This
attribute was added in vSphere API 6.7.1.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RedeploySpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vc_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ha_ip</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">failover_ip</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.vcha.cluster_client.Passive.RedeploySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Passive.RedeploySpec</span></code> class contains the redeploy specification.
This class was added in vSphere API 6.7.1.</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>vc_spec</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the active node’s management vCenter server credentials.
This attribute was added in vSphere API 6.7.1.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) – Contains the node’s placement information. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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.1.
If None, then the stored network configuration for the VCHA HA
network for the passive node will be used.</p></li>
<li><p><strong>failover_ip</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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.1.
If None, then the public IP address of the Active vCenter Server is
<codeclass="sig-name descname"><spanclass="pre">check</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.vcha.cluster_client.Passive.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Validates the specified passive node’s placement configuration. This
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<codeclass="sig-name descname"><spanclass="pre">redeploy_task</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.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.1.</p>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.vcha.cluster_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.vcha.cluster_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.vcha.cluster_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Witness</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.vcha.cluster_client.Witness"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Witness</span></code> class provides methods to validate a witness’s placement
configuration and redeploy the witness node in a vCenter High Availability
(VCHA) cluster. This class was added in vSphere API 6.7.1.</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">CheckResult</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">warnings</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">errors</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.vcha.cluster_client.Witness.CheckResult"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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.1.</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>warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <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>) – A list of problems which may require attention, but which are not
fatal. This attribute was added in vSphere API 6.7.1.</p></li>
<li><p><strong>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <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>) – A list of problems which are fatal to the operation and the
operation will fail. This attribute was added in vSphere API 6.7.1.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CheckSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vc_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement</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.vcha.cluster_client.Witness.CheckSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Witness.CheckSpec</span></code> class contains placement information for
validation. This class was added in vSphere API 6.7.1.</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>vc_spec</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the active node’s management vCenter server credentials.
This attribute was added in vSphere API 6.7.1.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) – Contains the node’s placement information for validation. This
attribute was added in vSphere API 6.7.1.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">RedeploySpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">vc_spec</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">placement</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ha_ip</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.vcha.cluster_client.Witness.RedeploySpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Witness.RedeploySpec</span></code> class contains the redeploy specification.
This class was added in vSphere API 6.7.1.</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>vc_spec</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.CredentialsSpec"title="com.vmware.vcenter.vcha_client.CredentialsSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.CredentialsSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Contains the active node’s management vCenter server credentials.
This attribute was added in vSphere API 6.7.1.
If None, then the active vCenter Server instance is assumed to be
either self-managed or else in enhanced linked mode and managed by
a linked vCenter Server instance.</p></li>
<li><p><strong>placement</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.PlacementSpec"title="com.vmware.vcenter.vcha_client.PlacementSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.PlacementSpec</span></code></a>) – Contains the node’s placement information. This attribute was added
in vSphere API 6.7.1.</p></li>
<li><p><strong>ha_ip</strong> (<aclass="reference internal"href="com.vmware.vcenter.html#com.vmware.vcenter.vcha_client.IpSpec"title="com.vmware.vcenter.vcha_client.IpSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.vcha_client.IpSpec</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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.1.
If None, then the stored network configuration for the VCHA HA
network for the witness node will be used.</p></li>
<codeclass="sig-name descname"><spanclass="pre">check</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.vcha.cluster_client.Witness.check"title="Permalink to this definition">¶</a></dt>
<dd><p>Validates the specified witness node’s placement configuration. This
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
<codeclass="sig-name descname"><spanclass="pre">redeploy_task</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.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.1.</p>
If the SSL certificate of the management vCenter server cannot be
validated.
The value of the data attribute of
<aclass="reference internal"href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error"title="com.vmware.vapi.std.errors_client.Error"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std.errors_client.Error</span></code></a> will be a class
